Campaign

Get campaign call details

Changed on

Retrieve detailed information for a specific campaign call.

get/campaigncalls/{id}

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/campaigncalls/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the campaign call

Response

Detailed information for the specified campaign call

idstring uuid

The unique identifier of the campaign call.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

campaign_idstring uuid

The unique identifier of the campaign. Returned from the POST /campaigns or GET /campaigns response.

outplan_idstring uuid

The unique identifier of the outbound plan. Returned from the POST /outplans or GET /outplans response.

outdial_idstring uuid

The unique identifier of the outbound dial. Returned from the POST /outdials or GET /outdials response.

outdial_target_idstring uuid

The unique identifier of the outbound dial target. Returned from the GET /outdials/{id}/targets response.

queue_idstring uuid

The unique identifier of the queue. Returned from the POST /queues or GET /queues response.

activeflow_idstring uuid

The unique identifier of the activeflow. Returned from the GET /activeflows response.

flow_idstring uuid

The unique identifier of the flow. Returned from the POST /flows or GET /flows response.

reference_type'none' | 'call' | 'flow'

Type of reference for the campaign call.

reference_idstring uuid

The unique identifier of the referenced resource. The actual resource type is determined by reference_type. Returned from the corresponding resource endpoint.

status'dialing' | 'progressing' | 'done'

Status of the campaign call.

result'' | 'success' | 'fail'

Result of the campaign call attempt.

destination_indexinteger

Index of the current destination being dialed.

try_countinteger

Number of dialing attempts made.

tm_createstring date-time

Timestamp when the campaign call was created.

tm_updatestring date-time

Timestamp when the campaign call was last updated.

tm_deletestring date-time

Timestamp when the campaign call was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  "outdial_target_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  "flow_id": "550e8400-e29b-41d4-a716-446655440000",
  "reference_type": "call",
  "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "progressing",
  "result": "success",
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "try_count": 2,
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Changes

  • d5569b315411Revision changes
    • warning

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

    • warning

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