put
https://api-smartflo.tatateleservices.com/v1/my_number/
This API allows you to update the My Numbers.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Sample Request
curl --request PUT \
--url https://api-smartflo.tatateleservices.com/v1/my_number/id \
--header 'accept: application/json' \
--header 'content-type: application/json'📘 Important!
Before we begin, note that the * sign denotes the mandatory variables in each table.
Request Variables (Path Params)
The following parameter is required to update my number:
| Variable Name | Description | Data Type |
|---|---|---|
| id | Id of the number. | string |
Request Variables (Body Params)
The following parameter is required to update my number:
| Variable Name | Description | Data Type |
|---|---|---|
| name | Name to be assigned to number. | string |
| destination | Destination for the number. | string |
| description | Description for the number. | string |
| sms_template | List of SMS Templates. | array of strings |
Destination Format Examples
- Routes the call to a specific agent (Mobile) →
agent||0501247020000- Routes the call to an agent (Extension) →
agent_extension||06028XXXX0146- Routes the call to an IVR menu →
ivr||57000- Routes the call to an Auto Attendant →
auto_attend||57000- Routes the call to a department →
department||108000- Applies a time-based rule →
time_condition||64000- Uses an external API-based dial plan →
api_dialplan||66ab41c183715fc7da- Uses a custom-defined dial plan →
custom_dialplan||Tatatele CDP- Routes the call to an Inbound Queue →
inbound_queue||19X90- Ends the call →
hangup||1
Response Variables
The response returned is as following:
| Variable Name | Description | Data Type |
|---|---|---|
| Success | The request success status, the possible values are: True (default) for success. False for failure. | Boolean |
| Message | The message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here. | String |