Introduction

​

Prerequisites

• A valid and active sms service - You can get one by visiting the Services page
• There are two ways to get a service ID:
  1. Use the List Services endpoint to list all services and retrieve the ID of the specific one you intend to use
  2. Go to the Services page and copy the ID by clicking on the copy file icon as shown in the image below.
• API client authorization - This endpoint requires the message.sms.send.oneway API client authorization scope to send one way sms messages. You can set up scopes on the API Clients page.

​

Sender Types

• Alphanumeric Sender is a custom, branded sender name you request for your team. Once approved, it’s yours to use freely for any message content.
• Belio-managed sender is a ready-to-use sender owned and operated by Belio (e.g. Managed OTP), intended for a specific purpose such as authentication. Because Belio owns and is responsible for these senders, their use is restricted to that purpose, and messages sent through them require additional approval. See Templates for how this applies to template-based sends.

​

Advanced Features

• correlator: A unique string to correlate the delivery receipt with the original message.
• callbackUrl: A URL where the delivery receipt will be sent.

curl --request POST \
  --url https://api.belio.co.ke/message/{serviceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    ...
  "receiptRequest": {
    "correlator": "<string>",
    "callbackUrl": "<string>"
  }
}'