Webhook requirements for SMS Subscription

The Quickstart Python SMS Messaging section shows the client.conversation.subscribe() request requiring a webhook_url field. It describes this field as “accessible from the public web”. Does this imply that applications must reside on publicly accessible servers? Are there DNS requirements? Are there suggestions for how to do development behind a corporate firewall for applications that require a subscription? Or, if development is on your laptop behind your home network router?

Also, the API Reference document for this field describes it as “The webhook that has been acquired during SMS API subscription…” which seems like an odd choice of words for a param to the subscription() method.

Hi Dominic,

For receiving SMS, CPaaS cloud is sending the SMS message via REST request to your application server via a webhook, therefore your application server should be publicly accessible.

For corporate network, we will include a document for DNS requirements.

About local development, you might consider a local endpoint using ngrok or Localtunnel or any other tunneling service and pass that endpoint to webhook_url for subscription.

Lastly, the API reference description is indeed wrong, we shall change it

As a python newbie, I might suggest that the webhook documentation include more example and/or references to how a webhook is implemented at all. e.g. I found a Flask framework that connected the dots for me.

@Dominic_Lunanuova - Noted, we will work on enhancing the docs with an example

Hi @Dominic_Lunanuova, please note we added a section that clarifies the IP whitelisting required for CPaaS access.
So a corporate firewall will use this list to allow access for CPaaS service
https://apimarket.att.com/developer/configuration

The suggestion to use ngrok was extremely helpful. It is quick to download and get running and satisfies all the CPAAS requirements for public routing.

1 Like

Good day,
I’m having problem subscribing for incoming sms using webhook and i don’t know/understand the cause…I also tried to play around with the ATT&T github resources, but i keep getting the same error; When i put a ngrok webhook link and click on the subscribe button, i keep getting “‘channel_id’: obj[‘callbackurl’], KeyError: ‘callbackurl’” which i have tried all possible best but to no avail… I need help on this.

Thanks

Hi @rose342 ,

Please contact our support team at https://apimarket.att.com/portal/support/overview
They will be happy to assist you