Send Messages
This endpoint allows you to deliver your transactional messages to your users
NOTE
You would need to register a sender ID with the endpoint mentioned below. All messages sent before then will be delivered with the default sender ID
Request
{{baseUrl}}api/v1/messaging/sms
Headers
Parameter | Type | Description |
---|---|---|
AppId | string | you would need to create an app to get your app ID |
Authorization | string | public secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G |
Body Parameters
Parameter | Type | Description |
---|---|---|
destination | number | Phone number of recipient |
message | string | body of message |
channel | string | can be either whatsapp or sms |
sender_id | string | Sender ID |
priority | boolean | Indicate if you want to send in priority mode. Default is false |
NOTE
There is the priority feature. You can automatically resend messages via any of the channels if one doesn't get delivered. If the priority is set to true, the default setup is sms, and then whatsapp. You can choose to set it however way you want in the channel parameter
Response Sample
{
"entity": {
"status": true,
"mobile": "2348054810238",
"message_id": "[email protected]_3EB092F69064FG74BC76",
"reference_id": "81512"
}
}
Request Sender ID
Register your Sender ID with this endpoint, you will get an email once it has been approved, all messages sent before then will be delivered with the default sender ID
Request
{{baseUrl}}api/v1/messaging/sender_id
Body Parameters
Parameter | Type | Description |
---|---|---|
sender_id | string | Sender ID you wish to register, should be less than 11 Characters |
Sender ID
Kindly Note that you can only register your sender Id on production only.
Response Sample
{
"entity": {
"message": "Sender ID Request Successful, you will get an email once its Activated."
}
}
Fetch Sender IDs
Fetch the list of all your Sender IDs
Request
{{baseUrl}}api/v1/messaging/sender_ids
Response Sample
{
"entity": [
{
"sender_id": "Dojah",
"activated": true,
"createdAt": "2020-10-30T09:54:17.145Z"
}
]
}
Updated over 1 year ago