GET /v1/transactions/{ticket}/status

Retrieve the current/latest status of an SMS transaction using its Ticket/Id.

Path parameters

  • ticket string Required

    Ticket/Id returned from send endpoint

Responses

  • 200 application/json

    Message status

    Hide response attributes Show response attributes object
    • Type string
    • MessageId string

      AppHive message ID

    • Status string
    • Content string
    • To string
    • From string
    • Reference string
    • Cost number(float)
    • DateCreated string(date-time)
    • EffectedAt string(date-time)
    • BalanceBefore number(float)
    • BalanceAfter number(float)
  • 401

    Unauthorized

  • 404

    Not found

GET /v1/transactions/{ticket}/status
curl \
 --request GET 'https://api.sierrahive.com/v1/transactions/5f6f9a96-d766-4787-ba08-1fa0939b7166/status' \
 --user "username:password"
Response examples (200)
{
  "Type": "SMS",
  "MessageId": "5f6f9a96-d766-4787-ba08-1fa0939b7166",
  "Status": "success",
  "Content": "hello customer",
  "To": "23230588654",
  "From": "MyCompany",
  "Reference": "my_reference_1",
  "Cost": 150,
  "DateCreated": "2019-12-12T11:01:30.324Z",
  "EffectedAt": "2019-12-12T11:01:30.644Z",
  "BalanceBefore": 10000,
  "BalanceAfter": 9850
}