Update inbound SMS webhook/URI
On this page
Set or change the inbound SMS webhook URL, format and shared secret for a phone number, or switch the number back to SMPP delivery.
Overview
This method allows you to update your inbound messaging webhook/URI for a phone number.
If you are an HTTP API customer and do not use SMPP, webhook_url must be a fully qualified URL, for example https://api.example.com/inbound-sms.
Leaving webhook_url blank or omitting it converts the number from HTTP POST delivery to SMPP delivery.
Make sure you have SMPP credentials set up and tested before converting numbers to SMPP, otherwise inbound messages can be lost.
Authentication
Authentication is done by passing your TSG Global API key via the Authorization header in the format "Authorization: Bearer <api_key>"
Method
Update per-DID configuration. Currently only the SMS webhook URL can be changed with this endpoint.
POST https://api-service.tsgglobal.world/v1/sms/webhook
Request Body
| Name | Type | Description |
|---|---|---|
| webhook_url | String | e.g. https://example.com/webhook |
| did* | String | DID you want to set/update SMS webhook endpoint for |
| webhook_type | String | postv2 (default) | postv1 | post3jam | smpp |
| x_api_key_header | String | This value will be passed as x-api-key header in the webhook http call. Can be used to secure your webhook API. (should not be provided if webhook_type is smpp) |
200: OK
Success
Example CURL
curl -n https://api-service.tsgglobal.world/v1/sms/webhook -XPOST -H "Authorization: Bearer <api_key>" \
-H "Content-Type: application/json" -d '{
"webhook_url": "https://example.com/webhook",
"did": "12003004000"
}'