Sign in
workflow-configs

Create Outbound Call Config

Create a new outbound call configuration for a workflow.

post/api/v1/workflow-configs/{workflow_config_id}/outbound-configs

Path parameters

workflow_config_idstring uuid required

Request body

routing_keystring required
routing_valuesobject required
    Mapping of routing key values to routing destinations.
    
    New structure (recommended):
    {
        "90210": [
            {"destination_phone_number": "+15551234567", "retries": 3, "order": 1},
            {"destination_phone_number": "+15559876543", "retries": 2, "order": 2}
        ]
    }
    
    Legacy structure (still supported):
    {
        "90210": "+15551234567"
    }
voice_call_workflow_idstring uuid required
outbound_agentstring uuid required

Response

Successful Response

idstring uuid required
routing_keystring required
routing_valuesobject required
    Mapping of routing key values to routing destinations.
    
    New structure (recommended):
    {
        "90210": [
            {"destination_phone_number": "+15551234567", "retries": 3, "order": 1},
            {"destination_phone_number": "+15559876543", "retries": 2, "order": 2}
        ]
    }
    
    Legacy structure (still supported):
    {
        "90210": "+15551234567"
    }
voice_call_workflow_idstring uuid required
outbound_agentstring uuid required
tenant_idstring uuid required

Changes

Changed in 1 of the 5 revisions of this API.2

  • d65b8fefae342See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog