Hatif
    • Rate Limiting
    • Account API
      • Service Login
    • Channels API
      • Get Channels
    • Support API
      • Upload Image, Video, or PDF
      • Upload Audio File
    • Whatsapp API
      • Send Text
      • Send Template
      • Send Image
      • Send Audio
      • Send Video
      • Send File
      • Send Interactive Buttons
      • List Templates (Service Account)
    • Contact
      • Set Property Value on Contact
      • Search Contacts
      • Delete Property Value on Contact
      • Create Contact
      • Update Contact
      • Get Contacts
      • Get Contact By Id
      • Create Bulk Contacts vCards
      • Contacts History
    • Contact Properties
      • List Contact Properties
      • Contact Properties Statistics
      • Create Contact Property
      • Update Contact Property
      • Delete Contact Property
    • Workspace API
      • Get Workspace Users
    • Conversations API
      • Get Conversation Timeline
      • List Conversations
      • Create Conversation
      • Assign Conversation
      • Get Conversation
    • Tags API
      • Tag a conversation
      • Create Tag
      • Delete Tag
      • Update Tag
      • List Tags
    • Conversations - Service Account
    • Outbound IVR
      • Create Outbound IVR
      • Get Outbound IVR Request
    • Outbound IVR Flows
      • Create Outbound IVR Flow
      • List Outbound IVR Flows
      • Get Outbound IVR Flow
      • Update Outbound IVR Flow
      • Delete Outbound IVR Flow
    • Call Webhook
    • WhatsApp Message Webhook
    • Schemas
      • Call Webhook
      • WhatsApp Message Webhook
      • ConversationDto
      • CreateTagDto
      • ServiceAccountTemplateDto
      • OutboundIvrOption
      • ChannelConversationDto
      • UpdateTagDto
      • ServiceAccountTemplateParameterDto
      • OutboundIvrQuestionStepProps
      • TemplateParameterDto
      • OutboundIvrStep
      • TagDto
      • ParameterValueDto
      • ConversationTimelineDto
      • CreateOutboundIvrRequest
      • PagedResultOfTagDto
      • ChannelNotFoundError
      • SaveOutboundIvrFlow
      • OutboundIvrFlow
      • AiSummaryDto
      • ReplyInfoDto
      • OutboundIvrAnswer
      • InternalThreadDto
      • LocationMessageDto
      • OutboundIvrStatus
      • AssignationInfoDto
      • OutboundIvrResult
      • OutboundIvrAudioType
      • PagedResultOfConversationDto
      • OutboundIvrRequest
      • PagedResultOfConversationTimelineDto
      • OutboundIvrWebhookPayload

    OutboundIvrWebhookPayload

    Posted to your webhookUrl when the request reaches a terminal status. Note this is a narrower object than the Create/Get response — it carries no steps, options, or audio URLs.

    {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
        "externalId": "string",
        "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
        "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
        "destinationNumber": "+966501234567",
        "status": 0,
        "result": 0,
        "pressedDigit": "string",
        "answers": [
            {
                "stepKey": "budget",
                "stepIndex": 0,
                "digit": "3",
                "label": "Over 50k",
                "answeredAt": "2019-08-24T14:15:22.123Z"
            }
        ],
        "initiatedAt": "2019-08-24T14:15:22.123Z",
        "ringingAt": "2019-08-24T14:15:22.123Z",
        "answeredAt": "2019-08-24T14:15:22.123Z",
        "completedAt": "2019-08-24T14:15:22.123Z",
        "callDurationSeconds": 0,
        "callId": "4722cd84-0ec7-4ef5-8c34-1b0150f45f53",
        "errorMessage": "string",
        "hangupCause": "NORMAL_CLEARING",
        "creationTime": "2019-08-24T14:15:22.123Z"
    }
    Built with