The Senders API allows you to manage your existing senders on your account.
Creating new senders
To create a new sender you'll need to login to your Webex Interact account and navigate to Channel Setup from the left sided menu.
From here you can request a new alphanumeric sender or purchase a long number.
Method: GET
Use
Get all or subsets of senders on an account.
Parameters
| Parameter name | Type | Mandatory | Description |
|---|---|---|---|
| page_number | integer | No | Defaults to 1 page if not given. Use in conjunction with page_size to return a subset. |
| page_size | integer | No | Defaults to 25 items if not given. Determines the number of items returned per page. |
Sample request
GET https://api.webexinteract.com/assets/v1/senders/?page_number=1&page_size=1
Sample response
{
"paging": {
"current_page": 1,
"total_items": 24,
"total_pages": 24
},
"items": [
{
"id": "ssd_1zgeYliRwjSVJVw2h1uDlloIGcr",
"name": "mytestabc",
"status": "Verified"
}
]
}
{
"trace_id": "29faaedea3465268",
"errors": [
{
"message": "must be greater than 0",
"field": "get_all_sms_senders.page_size"
}
]
}
{
"trace_id": "b2c94535584d96f4",
"errors": [
{
"message": "must be less than or equal to 100",
"field": "get_all_sms_senders.page_size"
}
]
}
Use
Get a specific sender on an account, querying by ID.
Parameters
This endpoint requires no additional parameters.
Sample request
GET https://api.webexinteract.com/assets/v1/senders/ssd_1zgeYliRwjSVJVw2h1uDlloIGcr
Sample response
{
"id": "ssd_1zgeYliRwjSVJVw2h1uDlloIGcr",
"name": "mytestabc",
"status": "Verified"
}
Response Field Definitions
| Field | Description |
|---|---|
| id | Unique ID |
| name | Sender name |
| status | Pending - Awaiting internal review. Senders cannot be used until approved. Verified - Approved for use. |
Method: DELETE
Use
Delete a sender on an account.
Parameters
This endpoint requires no additional parameters.
Sample request
DELETE https://api.webexinteract.com/assets/v1/senders/ssd_1zgeYliRwjSVJVw2h1uDlloIGcr
Sample responses
HTTP/1.1 204 No Content
{
"trace_id": "1990s560932806a9",
"errors": [
{
"code": 3006,
"message": "Sender not found for the account."
}
]
}