Skip to main content

Messages

This is an object for you to send a message. The request for an order will first check if there is sufficient balance in your account and if successful, the message will be sent. The response will show that the request is in sync. A callback url is required so as to receive the final status of the request. You could also check the status of the transaction using the status object.

POST: /v1/b2b/send

Services​

  • sms
  • telegram
  • whatsapp

Request​

    curl -X POST \
     https://api.tupay.africa:8888/v1/b2b/send/{service} \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer {token}' \
     -H 'Idempotency-Key: {key}' \
     -d '"{"sender": "{sender}", "to": {to}, "message": {message}}"'
Message Request
{
    "sender": "TEST",
    "to": "254722000000",
    "message": "This is a test",
    "schedule": "now",
    "unique": "yes"
}
  • sender (String): The sender id (Email hello@allpremium.co.ke to apply for one)
  • to (String / Array): The recipient(s) (limited to 1k)
  • message (String): The message
  • schedule (String): Your schedule (now / repeat) *optional
  • options (String): The options for repeat *optional
  • unique (String): If duplicates should be filtered out (yes / no) *optional

Response​

Message Response
{
    "id": "ABCDEFG250101",
    "reference": "ref1234",
    "status": 20,
    "mesasge": "Pending"
}
  • id (String): The transaction id (Optional incase of failure)
  • reference (String): Your unique id
  • status (Integer): The status of the request
  • message (String): The response message