Skip to content
First requestVisit website ↗
Navigation

Send an agent text to a contact from the Call Center profile

Sends one SMS to a workspace contact from the Calling / standalone Call Center profile drawer. Denials run in a fixed order BEFORE the carrier is reached: authentication, workspace membership and contact visibility, contact tenancy, Sandbox Mode whitelist, DNC / SMS opt-out. The message then gets merge-field rendering and the GSM-7 body guard, is sent from the same number LiveChat would use (contact board number, registered short code, or the workspace default) and is saved to the LiveChat thread.

POST
https://api.channelautomation.com/api/call-center/contacts/{contactId}/text

Authorization

  • BearerAuth
    HTTP Bearer (JWT)
    required

Path parameters

  • contactId
    string
    required

    Contact to text; must belong to the authenticated workspace.

    format: uuid

Header parameters

  • X-Workspace-Id
    optional
    string

    Workspace to act in. Membership is verified; defaults to the token's workspace.

Request body JSON required

  • message
    string
    required

    Message body. Merge fields such as {{contact.firstname}} are rendered.

    maxLength: 1600
  • userName
    optional
    string

    Display name saved on the message for the inbox (max 120 chars).

Returns

200

Message accepted by the carrier and saved to the LiveChat thread.

JSON
  • success
    optional
    boolean
  • messageSid
    optional
    string
  • from
    optional
    string

    Sending phone number actually used.

  • senderSource
    optional
    contact_board_number
    or
    contact_board_short_code
    or
    workspace_default
  • persisted
    optional
    boolean

    False only when the carrier accepted the message but the thread insert failed.

  • message
    optional
    object
    or null

400

Missing or over-length message text.

401

Missing or invalid bearer token.

403

Blocked by Sandbox Mode, DNC, or SMS opt-out (body carries blocked=true and reason), or no workspace access.

404

Contact not in this workspace.

409

Contact has no phone number.

500

Texting is not configured for the workspace.

502

Provider error. sendOutcome is rejected for an explicit provider 4xx (except timeout); unknown means acceptance could not be confirmed. Never automatically retry an unknown outcome.

503

Session or contact access could not be verified; no send attempted.

Type to search…

↑↓ navigate↵ selectEsc close