Update inbound SMS webhook/URI

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 utilize SMPP the posturl must be a fully qualified URL i.e. http://someapi.somedomain.com/somescript.php Leaving the posturl blank or not including it in your API call will convert the number from HTTP POST to SMPP Please be sure to have SMPP credentials setup and tested before converting numbers to SMPP or message loss could occur (which is bad).

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 sms webhook URL is available using this enpodint.

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"
}'