POST /v1/messages/sms
Basic auth

Uses Basic auth (clientid:clientsecret) and requires X-Wallet header containing the wallet token. Request is asynchronous; final status is delivered to CallbackUrl if provided.

Headers

  • X-Wallet string Required

    Wallet token header (e.g., "Token 333")

application/json

Body Required

  • From string Required

    Sender name (not more than 11 characters)

    Maximum length is 11.

  • To string Required

    Destination MSISDN in full E164 format without '+'

  • Content string Required

    Message content

  • Reference string

    Client reference (optional but recommended)

  • CallbackUrl string(uri)

    Callback URL (optional but recommended; must be valid)

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

POST /v1/messages/sms 
curl \
 --request POST 'https://api.sierrahive.com/v1/messages/sms' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --header "X-Wallet: Token 333" \
 --data '{"From":"MyCompany","To":"23230123456","Content":"hello customer","Reference":"my_reference_1","CallbackUrl":"http://mycompany.com/sms/callback"}'
Request examples 
# Headers
X-Wallet: Token 333

# Payload
{
  "From": "MyCompany",
  "To": "23230123456",
  "Content": "hello customer",
  "Reference": "my_reference_1",
  "CallbackUrl": "http://mycompany.com/sms/callback"
}
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"
}