Post SMS – Webhook

The SMS Webhook endpoint allows you to receive and process status updates for previously initiated verification via SMS message. This endpoint enables your system to be notified when a verification process has been completed successfully or has failed.

Configure the API Endpoint

https://api.betatel.com/api/v1/connect-hub/sms/webhook

• Method: POST

Set Up the Headers

Param	Value	Description
Content-type	application/json	Specifies the payload format.
x-api-key	{{x-api-key}}	API key for authorization.
x-user-id	{{x-user-id}}	User identifier for added security and tracking.

Craft the Request Body

Design the JSON payload to include the message ID and the status of the verification process.

Example of body

{
  "id": "4a33face-9f15-56f0-122f-d66d6729679c0",
  "status": "Success"
}

Field	Type	Required	Description
id	string	Yes	The unique identifier of the SMS message received in the initial response.
status	string	Yes	The status of the SMS verification process ("Success" or "Failed").

Code Snippets

cUrl

Example - cURL

curl --location 'https://api.betatel.com/api/v1/connect-hub/sms/webhook' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'x-user-id: YOUR_USER_ID' \
--data '{
  "id":"4a33face-9f15-56f0-122f-d66d6729679c0",
  "status":"Success"
}'

Python

Example - Python

import http.client
import json

conn = http.client.HTTPSConnection("api.betatel.com")
payload = json.dumps({
  "id": "4a33face-9f15-56f0-122f-d66d6729679c0",
  "status": "Success"
})
headers = {
  'Content-Type': 'application/json',
  'x-api-key': 'YOUR_API_KEY',
  'x-user-id': 'YOUR_USER_ID'
}
conn.request("POST", "/api/v1/connect-hub/sms/webhook", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Node.js

Example - Node.js

const axios = require('axios');
let data = JSON.stringify({
  "id": "4a33face-9f15-56f0-122f-d66d6729679c0",
  "status": "Success"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.betatel.com/api/v1/connect-hub/sms/webhook',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'YOUR_API_KEY',
    'x-user-id': 'YOUR_USER_ID'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

PHP

Example - PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.betatel.com/api/v1/connect-hub/sms/webhook',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{"id":"4a33face-9f15-56f0-122f-d66d6729679c0", "status":"Success"}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'x-api-key: YOUR_API_KEY',
    'x-user-id: YOUR_USER_ID'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

Example - Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://api.betatel.com/api/v1/connect-hub/sms/webhook")
  .header("Content-Type", "application/json")
  .header("x-api-key", "YOUR_API_KEY")
  .header("x-user-id", "YOUR_USER_ID")
  .body("{\"id\":\"4a33face-9f15-56f0-122f-d66d6729679c0\", \"status\":\"Success\"}")
  .asString();

C#

Example - C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.betatel.com/api/v1/connect-hub/sms/webhook");
request.Headers.Add("x-api-key", "YOUR_API_KEY");
request.Headers.Add("x-user-id", "YOUR_USER_ID");
var content = new StringContent("{\"id\":\"4a33face-9f15-56f0-122f-d66d6729679c0\", \"status\":\"Success\"}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Understanding the Response

Once the API processes your request, it returns a response containing the unique identifier, status, and a message indicating the result of the webhook processing.

JSON Schema:

{
  "id": "0a62face-6d15-11f0-962f-d89d6729654c",
  "status": "Success",
  "message": "OK"
}

• id: The unique identifier for the message.
• status: The status of the SMS verification process ("Success" or "Failed").
• message: Indicates the result of the webhook processing.

Error Handling

• 400 - Bad Request: Invalid parameters or malformed request
• 401 - Unauthorized: Authentication failed
• 404 - Not Found: The specified message id does not exist
• 500 - Internal Server Error: An unexpected error occurred on the server