StartOutboundVoiceContactRequest

StartOutboundVoiceContactRequest schema from Amazon Connect Service API

ChatContact CenterCustomer ServiceVoiceAIOmnichannel

Properties

Name	Type	Description
DestinationPhoneNumber	string	The phone number of the customer, in E.164 format.
ContactFlowId	string	The identifier of the contact flow for the outbound call.
InstanceId	string	The identifier of the Amazon Connect instance.
ClientToken	string	Idempotency token.
SourcePhoneNumber	string	The phone number associated with the Amazon Connect instance, in E.164 format.
QueueId	string	The queue for the call.
Attributes	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-connect/refs/heads/main/json-schema/start-outbound-voice-contact-request-schema.json",
  "title": "StartOutboundVoiceContactRequest",
  "description": "StartOutboundVoiceContactRequest schema from Amazon Connect Service API",
  "type": "object",
  "properties": {
    "DestinationPhoneNumber": {
      "type": "string",
      "description": "The phone number of the customer, in E.164 format.",
      "example": "+12065551212"
    },
    "ContactFlowId": {
      "type": "string",
      "description": "The identifier of the contact flow for the outbound call.",
      "example": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE"
    },
    "InstanceId": {
      "type": "string",
      "description": "The identifier of the Amazon Connect instance.",
      "example": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
    },
    "ClientToken": {
      "type": "string",
      "description": "Idempotency token."
    },
    "SourcePhoneNumber": {
      "type": "string",
      "description": "The phone number associated with the Amazon Connect instance, in E.164 format."
    },
    "QueueId": {
      "type": "string",
      "description": "The queue for the call.",
      "example": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE"
    },
    "Attributes": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "ContactFlowId",
    "DestinationPhoneNumber",
    "InstanceId"
  ]
}