Skip to main content

Routing / Webhooks

The 2 Way Messaging Routing / Webhooks is a mechanism that allows the Arpoone user to receive, in real time, inbound SMS's sent to the Arpoone platform, which are matched with a 2WM configuration that was previously set up. To achieve this, the Arpoone user must configure the Routing option when setting up keywords and/or fallback behavior.

The URL endpoint configured will be invoked by our server (HTTP/S POST), sending the inbound SMS information in JSON format.

Invocations​

The structure of the 2WM webhooks that Arpoone will send to the endpoint configured by the user is as follows:

[
  {
    "Id": <uuidv4>,
    "OrganizationId": <uuidv4>,
    "ReceiveDateTime": <datetime>,
    "From": <string>, (inbound SMS origin number)
    "To": <string>, (inbound SMS destination number)
    "Keyword": <string>, 
    "Text": <string>,
    "Encoding": <int>,
    "Mcc": <string>,
    "Mnc": <string>,
    "TotalSegments": <int>
  }
  ...
]

Important: The Arpoone user must ensure that a HTTP 200 (OK) response is returned upon success, otherwise, the webhook will be retried later.

Notes​

  • Special attention should be paid to the fact that in the HTTP request made by Arpoone, the request body is an array that can contain one or more inbound SMS, up to a maximum total of 1000 per HTTP request;

  • We recommend using the tool https://webhook.site for validation/testing of the 2WM webhook functionality, using the "Your Unique URL" value provided by the tool as the endpoint in the 2WM keyword configuration;

  • To optimize performance, Arpoone users should process the webhooks asynchronously to ensure a short response time to Arpoone's HTTP requests.