• Overview

  • Setup
  • Authentication Token
  • Discoverability

• Tutorials

  • • • Deliverability and Reporting
      • Keyword Tutorial - hello_world
      • Sending a Voice Message
      • Sending an Email
      • Sending an SMS
      • Sending Messages
      • TMS and Communications Cloud
      • Use Email Templates
      • Use SMS Templates

• Reference

  • • • messages
        • email
          • {email_id}
            • recipients
              • {id}
              • failed
              • sent
        • sms
          • {sms_id}
            • recipients
              • {id}
              • failed
              • sent
        • voice
          • {voice_id}
            • recipients
              • id
              • failed
              • sent
              • human
              • machine
              • busy
              • no_answer
              • could_not_connect
      • webhooks
        • {id}
      • message_types
        • {id}
      • keywords
        • {id}
          • commands
            • {command_id}
      • command_types
      • inbound
        • sms
          • {id}
            • command_actions
      • templates
        • email
          • {uuid}
        • sms
          • {uuid}
      • from_addresses
        • {id}
      • reports
        • messages
          • email
            • statistics
          • sms
            • statistics
      • deactivated_phone_numbers

• Download API Descriptor

  • As RAML
  • As JSON

Discoverability

Discoverability is an important part of the TMS API set. Querying a known, fixed endpoint returns a list of links that describe where additional resources can be located. Performing a GET to https://stage-tms.govdelivery.com/ returns a list of services that your account is authorized to use. If your account is enabled for sending SMS messages, you would have received a link to the sms message resource:

  {
    "_links": {
      "self": "/",
      "keywords": "/keywords",
      "command_types": "/command_types",
      "inbound_sms_messages": "/inbound/sms",
      "sms_messages": "/messages/sms",
      "email_messages": "/messages/email",
      "voice_messages": "/messages/voice"
    }
  }