ROroarkhq
Agent Endpoint

Create a new agent endpoint

Changed on

Creates a new agent endpoint for the authenticated project.

post/v1/agent/endpoint

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/agent/endpoint
  • Auth
    HTTP bearer

Request body

agentIdstring uuid required

Agent ID to associate this endpoint with

valuestring required

Phone number in E.164 format (e.g., +12345678900)

environmentstring

Environment name (default: production)

direction'INCOMING' | 'OUTGOING' | 'INCOMING_AND_OUTGOING' required

Call direction: INCOMING, OUTGOING, or INCOMING_AND_OUTGOING

outboundDialType'NONE' | 'HTTP_REQUEST'

Outbound dial type: NONE or HTTP_REQUEST (default: NONE)

outboundDialHttpRequestDefinitionIdstring uuid nullable

ID of the HTTP request definition for outbound dialing (required when outboundDialType is HTTP_REQUEST)

Response

The created agent endpoint

Changes

  • 887b091b3d81Revision changes
    • warning

      added the new DAILY enum value to the / response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

  • ec9443a8a36fRevision changes
    • warning

      added the new GOOGLE_CES enum value to the / response property for the response status

    • warning

      added the new KORE enum value to the / response property for the response status