vCita Messages API

The Messages API from vCita — 2 operation(s) for messages.

GitHub OpenAPI

Operations 2

POST /platform/v1/messages Create a Message #
GET /v2/conversations/{conversation_id}/messages Get Conversation Messages #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vcita:vcita-messages-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vcita-messages-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Communication Messages API
  description: Unified OpenAPI specification for communication domain
  version: '3.0'
  x-generated:
    sourceFiles:
    - contact_channels.json
    - communication.json
    - staff_notification.json
    - business_phone_numbers.json
    - legacy_v1_communication.json
    - activity_message.json
    - communication.json
    - conversations.json
    - notification_template.json
    - legacy_v2_communication.json
    - messages.json
    pathNormalizations:
    - file: communication.json
      basePath: /business/communication
      transformations:
      - original: /channels
        normalized: /business/communication/channels
        basePath: /business/communication
      - original: /channels/{uid}
        normalized: /business/communication/channels/{uid}
        basePath: /business/communication
      - original: /messages
        normalized: /business/communication/messages
        basePath: /business/communication
      - original: /messages/{messageUid}
        normalized: /business/communication/messages/{messageUid}
        basePath: /business/communication
      - original: /sessions
        normalized: /business/communication/sessions
        basePath: /business/communication
      - original: /sessions/typing
        normalized: /business/communication/sessions/typing
        basePath: /business/communication
      - original: /sessions/{uid}
        normalized: /business/communication/sessions/{uid}
        basePath: /business/communication
    - file: legacy_v1_communication.json
      basePath: /platform/v1
      transformations:
      - original: /conversations
        normalized: /platform/v1/conversations
        basePath: /platform/v1
      - original: /clients/{client_id}/conversations
        normalized: /platform/v1/clients/{client_id}/conversations
        basePath: /platform/v1
      - original: /messages
        normalized: /platform/v1/messages
        basePath: /platform/v1
      - original: /numbers/dedicated_numbers/assign
        normalized: /platform/v1/numbers/dedicated_numbers/assign
        basePath: /platform/v1
      - original: /numbers/dedicated_numbers/set_two_way_texting_status
        normalized: /platform/v1/numbers/dedicated_numbers/set_two_way_texting_status
        basePath: /platform/v1
      - original: /numbers/twilio
        normalized: /platform/v1/numbers/twilio
        basePath: /platform/v1
      - original: /numbers/twilio/{sub_account_id}
        normalized: /platform/v1/numbers/twilio/{sub_account_id}
        basePath: /platform/v1
    - file: conversations.json
      basePath: /v2
      transformations:
      - original: /conversations/{id}
        normalized: /v2/conversations/{id}
        basePath: /v2
    - file: legacy_v2_communication.json
      basePath: /v2
      transformations:
      - original: /conversations/{conversation_id}/messages
        normalized: /v2/conversations/{conversation_id}/messages
        basePath: /v2
    - file: messages.json
      basePath: /business/messaging
      transformations:
      - original: /v1/channels
        normalized: /business/messaging/v1/channels
        basePath: /business/messaging
      - original: /v1/channels/typing
        normalized: /business/messaging/v1/channels/typing
        basePath: /business/messaging
    pathConflicts: []
    componentConflicts:
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_communication
      files:
      - merged
      - communication.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_staff_notification
      files:
      - merged
      - staff_notification.json
    - type: schema
      name: Response
      resolution: Renamed to Response_business_phone_numbers
      files:
      - merged
      - business_phone_numbers.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_business_phone_numbers
      files:
      - merged
      - business_phone_numbers.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_activity_message
      files:
      - merged
      - activity_message.json
    - type: schema
      name: Response
      resolution: Renamed to Response_communication
      files:
      - merged
      - communication.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_conversations
      files:
      - merged
      - conversations.json
    totalPaths: 36
    totalComponents: 50
servers:
- url: https://api.vcita.biz
  description: Unified API Gateway server
tags:
- name: Messages
paths:
  /platform/v1/messages:
    post:
      description: '## Overview

        Creates a Message.


        Available for **Staff and Directory tokens**. Directory tokens require the `X-On-Behalf-Of` header with the target business UID.'
      parameters: []
      responses:
        '201':
          description: Success
          content:
            application/json:
              example:
                data:
                  conversation_uid: pyrbkggxakbjywxx
                  id: 21
                  uid: ysrimghchgc0x6zl
                status: OK
      summary: Create a Message
      tags:
      - Messages
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: '201'
        type: http_proxy
        uri: https:///platform/v1/messages
      x-auth-type: Application & Application User
      requestBody:
        content:
          application/json:
            schema:
              required:
              - message
              properties:
                message:
                  description: Message object wrapper.
                  required:
                  - client_id
                  - text
                  - direction
                  properties:
                    channels:
                      description: Comma-separated list of delivery channels (e.g., "sms", "email"). When omitted, the message is sent to all available channels.
                      type: string
                    client_id:
                      description: The UID of the recipient client. Required to identify the target contact and resolve the conversation.
                      type: string
                    conversation_title:
                      description: Title for the conversation. Optional; used when creating a new conversation.
                      type: string
                    conversation_uid:
                      description: UID of an existing conversation to add the message to. If omitted, the system creates or uses the client's default conversation.
                      type: string
                    direction:
                      description: 'The direction of the message. Required. Valid values: "client_to_business", "business_to_client".'
                      type: string
                      enum:
                      - client_to_business
                      - business_to_client
                    staff_id:
                      description: UID of the staff member sending the message. Optional — if omitted, the staff is auto-assigned based on business assignment rules.
                      type: string
                    text:
                      description: The text content of the message. Required. Plain text only — do not include HTML tags.
                      type: string
                  type: object
              type: object
      security:
      - Bearer: []
      operationId: postPlatformV1Messages
      x-operation-id-source: derived
  /v2/conversations/{conversation_id}/messages:
    get:
      description: '## Overview

        Retrieves a paginated list of messages within a specific conversation. Messages are returned in chronological order and include staff details, document attachments, and delivery status.


        Available for **Staff and Directory tokens**. Directory tokens require the `X-On-Behalf-Of` header with the target business UID.'
      parameters:
      - description: The unique identifier (UID) of the conversation to retrieve messages from.
        in: path
        name: conversation_id
        required: true
        schema:
          type: string
      - description: 'Page number of results. Default: 1'
        in: query
        name: page
        required: false
        schema:
          type: integer
      - description: 'How many items to return per page. Default: 20'
        in: query
        name: per_page
        required: false
        schema:
          type: integer
      - description: If set, returns only messages updated in the last minute. Useful for polling for new messages.
        in: query
        name: last_update
        required: false
        schema:
          type: boolean
      - description: When set to 'me', filters messages to only those visible to the current staff member's team view.
        in: query
        name: teams_view_filter
        required: false
        schema:
          type: string
      - description: Business UID to act on behalf of. Required for Directory tokens.
        in: header
        name: X-On-Behalf-Of
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success - Returns an array of message objects.
          content:
            application/json:
              example:
              - uid: gn5zqo7nfbwee21c
                text: Hi, this is a sample message.
                sub_type: text
                data: []
                message_description: Sample conversation
                appointment_title: null
                title: Sample conversation
                mail_delivered: false
                mail_sent: true
                mail_read: false
                direction: client_to_business
                created_at: '2026-02-10T13:19:05.000-08:00'
                created_at_h: Feb 10, 1:19 pm
                updated_at: '2026-02-10T13:19:05.000-08:00'
                conversation_uid: 3zumor3etkwgzun6
                message_of: message
                message_type: system
                messageable: null
                documents: []
                attachments: null
                trust: false
                channels:
                - email
                channel_uid: dujrmr24hpmerwkr
                staff:
                  uid: 3so2q8r2b35x7phd
                  full_name: John Doe
                  display_name: John Doe
                  email: john@example.com
                subject: Sample conversation
                was_read: false
                external_data: {}
        '404':
          description: Not Found - Conversation does not exist.
          content:
            application/json:
              example:
                error: Couldn't find Conversation
      summary: Get Conversation Messages
      tags:
      - Messages
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getV2ConversationsByConversationIdMessages
      x-operation-id-source: derived
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
    Conversations:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid staff bearer token in the Authorization header. Example: ''Authorization: Bearer {staff_token}''.'
x-provenance:
  method: searched
  source: https://developers.intandem.tech:443/reference
  harvested: '2026-11-15'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.intandem.tech/reference/availablephonenumberscontroller_findall.md
  - https://developers.intandem.tech/reference/businessphonenumberscontroller_create.md
  - https://developers.intandem.tech/reference/businessphonenumberscontroller_findall.md
  - https://developers.intandem.tech/reference/businessphonenumberscontroller_findone.md
  - https://developers.intandem.tech/reference/businessphonenumberscontroller_update.md
  - https://developers.intandem.tech/reference/channelscontroller_create.md
  - https://developers.intandem.tech/reference/channelscontroller_deletechannel.md
  - https://developers.intandem.tech/reference/channelscontroller_updatechannel.md
  - https://developers.intandem.tech/reference/contactchannelscontroller_index.md
  - https://developers.intandem.tech/reference/delete_platform-v1-numbers-twilio-sub-account-id.md
  - https://developers.intandem.tech/reference/delete_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-conversations-1.md
  - https://developers.intandem.tech/reference/get_platform-v1-conversations.md
  - https://developers.intandem.tech/reference/get_v2-conversations-conversation-id-messages.md
  - https://developers.intandem.tech/reference/get_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech/reference/get_v3-communication-notification-templates.md
  - https://developers.intandem.tech/reference/get_v3-communication-staff-notifications-uid.md
  - https://developers.intandem.tech/reference/getstaffnotificationstats.md
  - https://developers.intandem.tech/reference/listactivitymessages.md
  - https://developers.intandem.tech/reference/liststaffnotifications.md
  - https://developers.intandem.tech/reference/messagescontroller_createmessage.md
  - https://developers.intandem.tech/reference/messagescontroller_updatestatus.md
  - https://developers.intandem.tech/reference/post_business-messaging-v1-channels-typing.md
  - https://developers.intandem.tech/reference/post_business-messaging-v1-channels.md
  - https://developers.intandem.tech/reference/post_platform-v1-messages.md
  - https://developers.intandem.tech/reference/post_platform-v1-numbers-dedicated-numbers-assign.md
  - https://developers.intandem.tech/reference/post_platform-v1-numbers-twilio.md
  - https://developers.intandem.tech/reference/post_v3-communication-notification-templates.md
  - https://developers.intandem.tech/reference/post_v3-communication-staff-notifications.md
  - https://developers.intandem.tech/reference/put_platform-v1-numbers-dedicated-numbers-set-two-way-texting-status.md
  - https://developers.intandem.tech/reference/put_v2-conversations-id.md
  - https://developers.intandem.tech/reference/put_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech/reference/quotascontroller_getquota.md
  - https://developers.intandem.tech/reference/recordingscontroller_deletevoicecallrecording.md
  - https://developers.intandem.tech/reference/recordingscontroller_updatevoicecallrecording.md
  - https://developers.intandem.tech/reference/reportscontroller_getvoicecallstats.md
  - https://developers.intandem.tech/reference/sendactivitymessage.md
  - https://developers.intandem.tech/reference/sessionscontroller_createsession.md
  - https://developers.intandem.tech/reference/sessionscontroller_getsession.md
  - https://developers.intandem.tech/reference/sessionscontroller_logicdelete.md
  - https://developers.intandem.tech/reference/sessionscontroller_updatestatus.md
  - https://developers.intandem.tech/reference/sessionstypingcontroller_typingstatus.md
  - https://developers.intandem.tech/reference/settingscontroller_create.md
  - https://developers.intandem.tech/reference/settingscontroller_delete.md
  - https://developers.intandem.tech/reference/settingscontroller_get.md
  - https://developers.intandem.tech/reference/settingscontroller_update.md
  - https://developers.intandem.tech/reference/transcriptcontroller_gettranscript.md
  - https://developers.intandem.tech/reference/voicecallscontroller_create.md
  - https://developers.intandem.tech/reference/voicecallscontroller_get.md
  - https://developers.intandem.tech/reference/voicecallscontroller_getall.md
  - https://developers.intandem.tech/reference/voicecallscontroller_update.md
  - https://developers.intandem.tech:443/reference/availablephonenumberscontroller_findall.md
  - https://developers.intandem.tech:443/reference/businessphonenumberscontroller_create.md
  - https://developers.intandem.tech:443/reference/businessphonenumberscontroller_findall.md
  - https://developers.intandem.tech:443/reference/businessphonenumberscontroller_findone.md
  - https://developers.intandem.tech:443/reference/businessphonenumberscontroller_update.md
  - https://developers.intandem.tech:443/reference/channelscontroller_create.md
  - https://developers.intandem.tech:443/reference/channelscontroller_deletechannel.md
  - https://developers.intandem.tech:443/reference/channelscontroller_updatechannel.md
  - https://developers.intandem.tech:443/reference/contactchannelscontroller_index.md
  - https://developers.intandem.tech:443/reference/delete_platform-v1-numbers-twilio-sub-account-id.md
  - https://developers.intandem.tech:443/reference/delete_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech:443/reference/get_platform-v1-clients-client-id-conversations-1.md
  - https://developers.intandem.tech:443/reference/get_platform-v1-conversations.md
  - https://developers.intandem.tech:443/reference/get_v2-conversations-conversation-id-messages.md
  - https://developers.intandem.tech:443/reference/get_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech:443/reference/get_v3-communication-notification-templates.md
  - https://developers.intandem.tech:443/reference/get_v3-communication-staff-notifications-uid.md
  - https://developers.intandem.tech:443/reference/getstaffnotificationstats.md
  - https://developers.intandem.tech:443/reference/listactivitymessages.md
  - https://developers.intandem.tech:443/reference/liststaffnotifications.md
  - https://developers.intandem.tech:443/reference/messagescontroller_createmessage.md
  - https://developers.intandem.tech:443/reference/messagescontroller_updatestatus.md
  - https://developers.intandem.tech:443/reference/post_business-messaging-v1-channels-typing.md
  - https://developers.intandem.tech:443/reference/post_business-messaging-v1-channels.md
  - https://developers.intandem.tech:443/reference/post_platform-v1-messages.md
  - https://developers.intandem.tech:443/reference/post_platform-v1-numbers-dedicated-numbers-assign.md
  - https://developers.intandem.tech:443/reference/post_platform-v1-numbers-twilio.md
  - https://developers.intandem.tech:443/reference/post_v3-communication-notification-templates.md
  - https://developers.intandem.tech:443/reference/post_v3-communication-staff-notifications.md
  - https://developers.intandem.tech:443/reference/put_platform-v1-numbers-dedicated-numbers-set-two-way-texting-status.md
  - https://developers.intandem.tech:443/reference/put_v2-conversations-id.md
  - https://developers.intandem.tech:443/reference/put_v3-communication-notification-templates-uid.md
  - https://developers.intandem.tech:443/reference/quotascontroller_getquota.md
  - https://developers.intandem.tech:443/reference/recordingscontroller_deletevoicecallrecording.md
  - https://developers.intandem.tech:443/reference/recordingscontroller_updatevoicecallrecording.md
  - https://developers.intandem.tech:443/reference/reportscontroller_getvoicecallstats.md
  - https://developers.intandem.tech:443/reference/sendactivitymessage.md
  - https://developers.intandem.tech:443/reference/sessionscontroller_createsession.md
  - https://developers.intandem.tech:443/reference/sessionscontroller_getsession.md
  - https://developers.intandem.tech:443/reference/sessionscontroller_logicdelete.md
  - https://developers.intandem.tech:443/reference/sessionscontroller_updatestatus.md
  - https://developers.intandem.tech:443/reference/sessionstypingcontroller_typingstatus.md
  - https://developers.intandem.tech:443/reference/settingscontroller_create.md
  - https://developers.intandem.tech:443/reference/settingscontroller_delete.md
  - https://developers.intandem.tech:443/reference/settingscontroller_get.md
  - https://developers.intandem.tech:443/reference/settingscontroller_update.md
  - https://developers.intandem.tech:443/reference/transcriptcontroller_gettranscript.md
  - https://developers.intandem.tech:443/reference/voicecallscontroller_create.md
  - https://developers.intandem.tech:443/reference/voicecallscontroller_get.md
  - https://developers.intandem.tech:443/reference/voicecallscontroller_getall.md
  - https://developers.intandem.tech:443/reference/voicecallscontroller_update.md
  merge:
    pages: 102
    deduped: 294
    conflicts_kept_first: 0