Skip to main content
POST
Send a message

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Body

application/json
practice_id
string
required

Practice ID.

contact_phone_number
string
required

Recipient phone number in E.164 format.

Example:

"+15105550123"

message
string
required

Message body.

Maximum string length: 1024
mms_media
string[]

Optional IDs of previously uploaded media attachments.

Maximum array length: 10

Response

Message accepted and recorded as a practice interaction.

id
string
read-only
Minimum string length: 1
occurred_at
string<date-time>
read-only
practice_contact
object
read-only
content_object
string
read-only
interaction_type
enum<string>
read-only
Available options:
call,
message,
voicemail,
conversation_webchat,
conversation_voicechat,
conversation_sms,
fax
practice_phone_number
string | null
read-only
Minimum string length: 1
contact_phone_number
string | null
read-only
Minimum string length: 1
interaction_direction
enum<string>
read-only
Available options:
inbound,
outbound,
not_applicable
is_viewed
boolean
read-only