Send a text message

Send a text message from your Quo number to a recipient.

POST /v1/messages

Send a text message

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/v1/messages \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "from": "[phone]",
  "to": [
    "[phone]"
  ],
  "phoneNumberId": "OP1232abc",
  "userId": "US123abc",
  "setInboxStatus": "done"
}
'

202

{
  "data": {
    "id": "AC123abc",
    "to": [
      "[phone]"
    ],
    "from": "[phone]",
    "text": "Hello, world!",
    "phoneNumberId": "PN123abc",
    "conversationId": "CN123abc",
    "direction": "incoming",
    "userId": "US123abc",
    "status": "sent",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "media": [
      {
        "url": "https://example.com/image.png",
        "type": "image/png"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Body

application/json

content · string · required

The text content of the message to be sent.

Required string length: 1 - 1600

Pattern: .*\S.*

from · Option 1 · string Option 2 · string · required

The sender's phone number. Can be either your Quo phone number ID or the full phone number in E.164 format.

Pattern: ^PN(.*)$

Example:

"[phone]"

to · string[] · required

Array of recipient phone numbers in E.164 format. Currently supports a maximum of 10 recipients

Required array length: 1 - 10 elements

A phone number in E.164 format, including the country code.

Pattern: ^\+[1-9]\d{1,14}$

Example:

"[phone]"

Example:

["[phone]"]

phoneNumberId · string · deprecated

DEPRECATED, use "from" instead. Quo phone number ID to send a message from

Pattern: ^PN(.*)$

Example:

"OP1232abc"

userId · string

The unique identifier of the Quo user sending the message. If not provided, the message is attributed to the owner of the phone number it is sent from. The sending user must be a member of the phone number the message is sent from.

Pattern: ^US(.*)$

Example:

"US123abc"

setInboxStatus · enum<string>

Used to set the status of the related Quo inbox conversation. The default behavior without setting this parameter will be for the message sent to show up as an open conversation in the user's inbox. Setting the parameter to 'done' would move the conversation to the Done inbox view.

Available options: done

Example:

"done"

Response

202

application/json

Accepted

data · object · required

Show child attributes