GET /v1/messages/sms

Credentials are passed as URL parameters for GET requests. Request is asynchronous; final status is delivered to callbackUrl.

Query parameters

  • clientid string Required
  • clientsecret string Required
  • token string Required

    Wallet token

  • from string Required

    Maximum length is 11.

  • to string Required
  • reference string
  • content string Required
  • callbackUrl string(uri)

Responses

  • 200 application/json

    Accepted for processing (initial status)

    Hide response attributes Show response attributes object
    • Cost number(float) Required

      Initial cost (may be 0.0 at submission time)

    • Destination string Required
    • Id string(uuid) Required

      ID from AppHive

    • Ticket string(uuid) Required

      Same as Id

    • ClientReference string | null

      Your reference (if provided)

    • Status string Required

      Initial transaction status
  • 400

    Bad request

  • 401

    Unauthorized

GET /v1/messages/sms 
curl \
 --request GET 'https://api.sierrahive.com/v1/messages/sms?clientid=111&clientsecret=222&token=333&from=MyCompany&to=23230123456&content=hello+customer'
Response examples (200) 
{
  "Cost": 0.0,
  "Destination": "23230123456",
  "Id": "5f6f9a96-d766-4787-ba08-1fa0939b7166",
  "Ticket": "5f6f9a96-d766-4787-ba08-1fa0939b7166",
  "ClientReference": "my_reference_1",
  "Status": "pending"
}