MessageWithHistory

Fields

• idstringRequired

  The message ID: msg_ followed by 26 characters.

  • Matches ^msg_[0-9A-HJKMNP-TV-Z]{26}$
• objectstringRequired

  Always message.

  • Always message
• amountstringor nullRequired

  What you were charged: the segments times unit_price, never more than held_amount. null until the message is sent; 0.0000 when it was rejected, failed or cancelled.

  • Matches ^\d+\.\d{4}$
• bodystringRequired

  The message text, exactly as sent.

• campaign_idstringor nullRequired

  The campaign the message belongs to, for messages sent from the dashboard.

  • Matches ^cmp_[0-9A-HJKMNP-TV-Z]{26}$
• channelstringRequired

  Always sms.

  • One of: sms
• client_referencestringor nullRequired

  Your own reference for the message, as you sent it.

• completed_atstring (date-time)or nullRequired

  When the message reached its current final status; null before that.

• created_atstring (date-time)Required

  When the message was accepted.

• currencystringRequired

  Always NGN. Amounts are strings with four decimal places.

  • Always NGN
• directionstringRequired

  Always outbound.

  • One of: outbound
• encodingstringRequired

  gsm7, or ucs2 when the body has a character outside the GSM 7-bit alphabet, such as the naira sign.

  • One of: gsm7, ucs2
• errorErroror nullRequired

  Why the message was rejected, failed, cancelled, undelivered or expired; otherwise null.

• fromstringRequired

  The sender ID the message is sent from.

• held_amountstringRequired

  The most this message can cost, held from your balance when it was accepted; 0.0000 for a rejected message.

  • Matches ^\d+\.\d{4}$
• modestringRequired

  live for a live key. Always live today: test keys are not available yet.

  • One of: live, test
• scheduled_atstring (date-time)or nullRequired

  The send_at time you asked for; null when you sent it straight away.

• segmentsintegerRequired

  How many SMS parts the body takes, from 1 to 10. Prices are per segment.

  • At least 1
• sent_atstring (date-time)or nullRequired

  When a route accepted the message; null before that.

• sourcestringRequired

  How the message was sent: api, campaign, quick_send or test_send.

  • One of: api, campaign, quick_send, test_send
• statusstringRequired

  Where the message is now. scheduled, queued and sent are in progress. delivered, undelivered, expired, rejected, failed and cancelled are final, and completed_at is set when the message reaches one. A late delivery receipt can still move an undelivered or expired message to delivered, and an expired one to undelivered.

  • One of: scheduled, queued, sent, delivered, undelivered, expired, rejected, failed, cancelled
• tostringRequired

  The recipient in E.164 format; the value you sent when it could not be read.

• unit_pricestringor nullRequired

  The price per segment of the route that carried the message; null until it is sent.

  • Matches ^\d+\.\d{4}$
• updated_atstring (date-time)Required

  When the message last changed.

• status_historyarray of MessageHistoryEntryRequired

  Every status the message has had, oldest first.

Used by

• Get a message