Send an SMS message with the Volt GraphQL API

This article walks step-by-step through sending an SMS message using the Volt GraphQL API.

 Instructions

First, ensure that you have access to the data necessary for utilizing the Volt GraphQL API:

1. Have your Volt GraphQL API access token readily available. If you are unsure of where to locate your API token, contact api@textvolt.com.

2. To send an SMS message using the GraphQL API, you will need to specify the sending and receiving phone numbers, the message content, and a publicly accessible URL for media (if sending MMS).

Next, use the necessary data to send a message using the GraphQL API. For example, if you want to send an SMS message with the sending number +15555550123 and the receiving number +15555550145, construct a GraphQL API request:

1. Set the Authorization header to the value Bearer <token>, replacing <token> with the API access token belonging to your organization.

2. Construct a GraphQL query using the createMessage mutation:
   
   

   mutation createMessage ($to: String!, $from: String!, $body: String!, $media: [String!]) { createMessage (to: $to, from: $from, body: $body, media: $media) { id legacyId toNumber fromNumber status statusDescription media body sentAt confirmedAt } }

    

3. Construct a JSON object containing the GraphQL variables for the query created in the previous step:
   
   

   { "to": "+15555550145", "from": "+15555550123", "body": "Your One Time Code is 654312\n\nReply STOP to opt-out.", "media": [] }

   Note: to send an MMS message, set the media variable to a list of publicly-accessible media URLs corresponding to the media you wish to send. Supported file types are: JPEG, PNG, GIF, VCF (vCard).

4. Send a POST request to https://api.respondflow.com/graphql with the GraphQL query and variables in the request body. We recommend using a GraphQL client library in the language of your choice to construct and send GraphQL API requests.
   
   For example, to send the above GraphQL request using curl:
   
   

   curl --location --request POST 'https://api.respondflow.com/graphql' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{"query":"mutation createMessage ($to: String!, $from: String!, $body: String!, $media: [String!]) {\n createMessage (to: $to, from: $from, body: $body, media: $media) {\n id\n legacyId\n toNumber\n fromNumber\n status\n statusDescription\n media\n body\n sentAt\n confirmedAt\n }\n}","variables":{"to":"+15555550145","from":"+15555550123","body":"Your One Time Code is 654312\n\nReply STOP to opt-out.","media":[]}}'

    

 Related articles

• Introduction to GraphQL

• GraphQL Client Libraries by Language

• Volt GraphQL API Reference

• Volt GraphQL Postman Collection

Examples by Language

These code snippets exhibit examples of sending SMS using the GraphQL API without using a GraphQL client library.

C#

Go

HTTP

Java

JavaScript (Node)

PHP

Python

Ruby

Unix shell (curl)