POST
/
v1
/
messages
curl --request POST \
  --url https://api.openphone.com/v1/messages \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "<string>",
  "phoneNumberId": "OP1232abc",
  "from": "<string>",
  "to": [
    "+15555555555"
  ],
  "userId": "US123abc",
  "setInboxStatus": "done"
}'
{
  "data": {
    "id": "AC123abc",
    "to": [
      "+15555555555"
    ],
    "from": "+15555555555",
    "text": "Hello, world!",
    "phoneNumberId": "PN123abc",
    "direction": "incoming",
    "userId": "US123abc",
    "status": "sent",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z"
  }
}

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
​
from
required
​
to
string[]
required

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

​
phoneNumberId
string
deprecated

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

Example:

"OP1232abc"

​
userId
string

The unique identifier of the OpenPhone user sending the message. If not provided, defaults to the phone number owner.

Example:

"US123abc"

​
setInboxStatus
enum<string>

Used to set the status of the related OpenPhone 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
Success
​
data
object
required

Was this page helpful?