> This page is for APIs.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# calling.ai_message

GET /

Send a message to an active AI agent session

Reference: https://signalwire.com/docs/apis/relay/server/calling/calling-ai-message

## AsyncAPI Specification

```yaml
asyncapi: 2.6.0
info:
  title: calling.ai_message
  version: subpackage_callingAiMessage.calling.ai_message
  description: Send a message to an active AI agent session
channels:
  /:
    description: Send a message to an active AI agent session
    publish:
      operationId: subpackage_callingAiMessage.calling.ai_message-publish
      summary: calling.ai_message response
      message:
        name: onCallingAiMessageResponse
        title: calling.ai_message response
        payload:
          $ref: '#/components/schemas/calling.ai_message_callingAiMessageResponse'
    subscribe:
      operationId: subpackage_callingAiMessage.calling.ai_message-subscribe
      summary: calling.ai_message
      message:
        name: callingAiMessage
        title: calling.ai_message
        payload:
          $ref: '#/components/schemas/calling.ai_message_callingAiMessageRequest'
servers:
  production:
    url: wss://relay.signalwire.com/
    protocol: wss
    x-default: true
components:
  schemas:
    ChannelsCallingAiMessageMessagesCallingAiMessageResponseJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallingAiMessageMessagesCallingAiMessageResponseJsonrpc
    Calling.AiMessageResult:
      type: object
      properties:
        code:
          type: string
          description: >-
            Result code as a string. `"200"` means success. Failures use an
            HTTP-style code

            such as `"400"` (bad request), `"403"`, `"404"` (call not found),
            `"405"`, `"409"`

            (conflict, for example another operation is still running), `"410"`
            (call gone),

            or `"500"`. If the call could not be reached in time, `code` is a
            lowercase error

            identifier instead, such as `response_timeout`, `not_available`, or

            `internal_error`.
        message:
          type: string
          description: >-
            Human-readable description of the result. On failure, it explains
            what went wrong. Always check `code`; `message` may be omitted when
            there is nothing extra to report.
        call_id:
          type: string
          description: The call this result is for, echoed from your request.
      required:
        - code
      description: >-
        Confirmation that the message was injected into the AI session.
        `message` is the

        raw status line (`"+OK Success\n"`). If no AI session is running on the
        call,

        `code` is `"400"` with an `-ERR` message.
      title: Calling.AiMessageResult
    JsonRpcErrorCode0:
      type: string
      enum:
        - '-32000'
      title: JsonRpcErrorCode0
    JsonRpcErrorCode1:
      type: string
      enum:
        - '-32001'
      title: JsonRpcErrorCode1
    JsonRpcErrorCode2:
      type: string
      enum:
        - '-32002'
      title: JsonRpcErrorCode2
    JsonRpcErrorCode3:
      type: string
      enum:
        - '-32003'
      title: JsonRpcErrorCode3
    JsonRpcErrorCode4:
      type: string
      enum:
        - '-32004'
      title: JsonRpcErrorCode4
    JsonRpcErrorCode5:
      type: string
      enum:
        - '-32005'
      title: JsonRpcErrorCode5
    JsonRpcErrorCode6:
      type: string
      enum:
        - '-32600'
      title: JsonRpcErrorCode6
    JsonRpcErrorCode7:
      type: string
      enum:
        - '-32601'
      title: JsonRpcErrorCode7
    JsonRpcErrorCode8:
      type: string
      enum:
        - '-32602'
      title: JsonRpcErrorCode8
    JsonRpcErrorCode9:
      type: string
      enum:
        - '-32603'
      title: JsonRpcErrorCode9
    JsonRpcErrorCode10:
      type: string
      enum:
        - '-32700'
      title: JsonRpcErrorCode10
    JsonRpcErrorCode:
      oneOf:
        - $ref: '#/components/schemas/JsonRpcErrorCode0'
        - $ref: '#/components/schemas/JsonRpcErrorCode1'
        - $ref: '#/components/schemas/JsonRpcErrorCode2'
        - $ref: '#/components/schemas/JsonRpcErrorCode3'
        - $ref: '#/components/schemas/JsonRpcErrorCode4'
        - $ref: '#/components/schemas/JsonRpcErrorCode5'
        - $ref: '#/components/schemas/JsonRpcErrorCode6'
        - $ref: '#/components/schemas/JsonRpcErrorCode7'
        - $ref: '#/components/schemas/JsonRpcErrorCode8'
        - $ref: '#/components/schemas/JsonRpcErrorCode9'
        - $ref: '#/components/schemas/JsonRpcErrorCode10'
      title: JsonRpcErrorCode
    JsonRpcError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/JsonRpcErrorCode'
          description: >-
            The error code — a negative integer identifying the failure. See
            `JsonRpcErrorCode` for the full list of values and meanings.
        message:
          type: string
          description: A human-readable description of what went wrong.
        original_request:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            An echo of the request that failed — the full JSON-RPC frame you
            sent

            (`jsonrpc`, `id`, `method`, `params`). Always present.
        requester_nodeid:
          type: string
          description: >-
            The node that sent the failed request. Present only on some routing
            errors.
        requester_identity:
          type: string
          description: >-
            The identity of the requester. Present only on some routing errors;
            same value as `requester_nodeid`.
        responder_nodeid:
          type: string
          description: >-
            The node that was handling the request. Present only on some routing
            errors.
        responder_identity:
          type: string
          description: >-
            The identity of the responder. Present only on some routing errors;
            same value as `responder_nodeid`.
        last_hop_timeout:
          type: boolean
          description: >-
            `true` when the request timed out on its final hop inside
            SignalWire. Present only on some timeout errors.
      required:
        - code
        - message
        - original_request
      description: >-
        A JSON-RPC 2.0 error object, delivered on the `error` field of a
        `JsonRpcResponse` when

        a request fails at the protocol level (bad version, authentication,
        scope, params, or

        your project's connection limit). It replaces `result` — a frame carries
        one or the other, never both.
      title: JsonRpcError
    calling.ai_message_callingAiMessageResponse:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallingAiMessageMessagesCallingAiMessageResponseJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: The id of the request this responds to.
        result:
          $ref: '#/components/schemas/Calling.AiMessageResult'
          description: The method result. Present when the request succeeded.
        error:
          $ref: '#/components/schemas/JsonRpcError'
          description: >-
            Present instead of `result` when the request failed at the protocol
            level.
      required:
        - jsonrpc
        - id
      description: >-
        A JSON-RPC response frame correlated to a request by `id`. On success
        the frame carries

        `result` (the method result). If the request fails at the protocol level
        — an

        incompatible version, failed authentication, insufficient scope, invalid
        params, or your

        project's connection limit — the frame carries `error` instead of
        `result`. Many

        method-level failures (for example most Calling failures) are reported
        the other way: a

        normal `result` whose own `code` is not `"200"`. Each method documents
        which form its

        failures take.


        An `error` returned for `signalwire.connect` is followed by the service
        closing the

        WebSocket; open a new connection to try again. The same happens when

        `signalwire.reauthenticate` sends credentials that are rejected, except
        for a

        Subscriber Access Token. Errors on any other request leave the
        connection open.
      title: calling.ai_message_callingAiMessageResponse
    ChannelsCallingAiMessageMessagesCallingAiMessageRequestJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallingAiMessageMessagesCallingAiMessageRequestJsonrpc
    ChannelsCallingAiMessageMessagesCallingAiMessageRequestMethod:
      type: string
      enum:
        - calling.ai_message
      description: The name of the JSON-RPC method being invoked.
      title: ChannelsCallingAiMessageMessagesCallingAiMessageRequestMethod
    Calling.AiMessageRole:
      type: string
      enum:
        - system
        - user
        - assistant
      title: Calling.AiMessageRole
    CallingAiMessageParamsRole:
      oneOf:
        - $ref: '#/components/schemas/Calling.AiMessageRole'
        - type: string
      description: >-
        Role of the message sender: `system`, `user`, or `assistant`. Any other
        value

        is accepted and treated as `user`. Defaults to `user`.
      title: CallingAiMessageParamsRole
    Calling.AiMessageReset:
      type: object
      properties:
        full_reset:
          type: boolean
          description: Clear the entire conversation history.
        user_prompt:
          type: string
          description: Replace (or clear) the user prompt context.
        system_prompt:
          type: string
          description: Replace (or clear) the system prompt context.
      description: >-
        Conversation-reset configuration. Each field clears or replaces part of
        the

        session context.
      title: Calling.AiMessageReset
    Calling.AiMessageParams:
      type: object
      properties:
        node_id:
          type: string
          description: >-
            Opaque identifier that, paired with `call_id`, addresses this call.
            Echo back the value you received; treat it as opaque.
        call_id:
          type: string
          description: Unique identifier of the call.
        message_text:
          type: string
          description: Message text to inject into the session.
        role:
          $ref: '#/components/schemas/CallingAiMessageParamsRole'
          description: >-
            Role of the message sender: `system`, `user`, or `assistant`. Any
            other value

            is accepted and treated as `user`. Defaults to `user`.
        reset:
          $ref: '#/components/schemas/Calling.AiMessageReset'
          description: >-
            Conversation-reset configuration. When present, `message_text` and
            `global_data` in the same request are ignored.
        global_data:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            Updates the global data available to your SWAIG (SignalWire AI
            Gateway)

            functions. Merges into the existing global data; set a key to `null`
            to remove

            it. Can be sent on its own to update state without injecting a
            message.
      required:
        - node_id
        - call_id
      description: >-
        Parameters for `calling.ai_message`. There are two modes: send `reset`
        to

        reconfigure the conversation context, or send `message_text` and/or

        `global_data` to inject a message and update state. If `reset` is
        present,

        `message_text` and `global_data` in the same request are ignored — send
        those in

        a separate request.
      title: Calling.AiMessageParams
    calling.ai_message_callingAiMessageRequest:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallingAiMessageMessagesCallingAiMessageRequestJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: Request id, echoed on the correlated response.
        method:
          $ref: >-
            #/components/schemas/ChannelsCallingAiMessageMessagesCallingAiMessageRequestMethod
          description: The name of the JSON-RPC method being invoked.
        params:
          $ref: '#/components/schemas/Calling.AiMessageParams'
          description: The method's input parameters.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        A JSON-RPC request frame. `Method` is the method name; `Params` is the
        method's input.
      title: calling.ai_message_callingAiMessageRequest

```