To facilitate a seamless transition from the Textlocal to the Webex Interact API, we have set up an API compatibility service. It serves as a bridge between Textlocal and Webex Interact SMS endpoints, allowing customers to continue using Textlocal endpoints while Webex Interact handles the request. This setup ensures an uninterrupted service and a smooth migration to the Webex Interact API.
What do I need to do to begin using the proxy?
Apart from completing the upgrade journey, no changes are required.
At the point that the data migration is complete and you gain access to your new Webex Interact account, there will be an automatic and seamless switch over. From this point, all calls to the Textlocal send endpoint will be passed over to be serviced on your Webex Interact account.
Can I expect any changes to the responses that I receive?
In general, you can expect the same structure, fields and values to be returned in the same way as you did prior to your upgrade.
However, due to the difference in the way that messages are billed, the balance and cost values are now returned as a float.
What about authentication?
Again, there's no change required here. Any of your Textlocal API keys will continue to be valid following your upgrade. If you have set up an allowed list of IP addresses or an IP address range, these will continue to be upheld.
What about auto-top ups?
Any auto-topup configurations are not carried over to your new account.
We would recommend to all API customers that an auto-topup and a monthly auto recharge schedule is set on your Webex Interact account to avoid service outages.
You can do this by selecting 'Add Balance' and setting up your automatic payments from Balance and purchases.
Supported endpoints
Webex Interact currently supports the following endpoint:
Supported parameters
Webex Interact API supports most of the send endpoint's parameters for sending messages. However, not all Textlocal parameters work with the Interact API where using unsupported parameters will cause errors. To ensure a smooth transition, use only the parameters listed below:
Textlocal send | Webex Interact SMS | Description |
apiKey | API key((login)) | Specify your API key. Create these under the Developers>API page and limit the usage of them by host IP address. |
message | message body | Specify the body of the SMS, which can include merge fields and contact placeholders. |
sender | from | Specify the Sender ID. If there is no ID, it will be created automatically. |
numbers | to | Specify the phone numbers in E.164 format to which the SMS will be sent. (This is equivalent to numbers in Textlocal). |
group_id |
| Parameter not supported. Passing this parameter will result in an error. |
simple_reply |
| Parameter not supported. Passing this parameter will result in an error. |
schedule_time |
| Specify a schedule time up to 390 days in advance of today's date. Value to be provided as a UNIX timestamp. |
receipt_url |
| Use this field to specify a URL to which the delivery receipt(s) will be sent. The URL given here will override what is set in your settings on your account. |
valid_until | validity | Specify the validity of your message. |
unicode | N/A* | Specify that your message body contains unicode characters. |
optouts | skip opt-out check | Set this value to true to skip opt-out checks for specified phone numbers |
custom | N/A* | Specify the messages to be sent in batch and will pass in the delivery receipts. |
tracking_links |
| Parameter not supported. Passing this parameter will result in an error. |
test | N/A* | Set this value to true to enable test mode, no messages will be sent, and your balance will be unaffected. |
These parameters are handled via the proxy but are yet to be supported directly by the Webex Interact SMS endpoint
📘Note: The transition from Textlocal to Webex Interact API needs an understanding of these differences to ensure seamless message sending. Always use the supported parameters to avoid errors.
Sample response
{
"testmode ": true,
"balance": 12345.56,
"cost": 0.049,
"num_messages": 1,
"message": {
"num_parts": 1,
"sender": "Textlocal",
"content": "@U0074",
},
"receipt_url": "",
"custom": "",
"messages": [
{
"id": 1,
"recipient": 447482063988
}
],
"status": "success"
}