Sign in
Groupcall

Create a new groupcall

Creates a new groupcall with the specified information and returns the created groupcall.

post/groupcalls

Request body

flow_idstring uuid

The flow to execute for the groupcall. Provide either flow_id or actions; if both are set, flow_id takes precedence and actions is ignored. The flow ID returned from the POST /flows or GET /flows response.

ring_method'' | 'ring_all' | 'linear' required

Method used for dialing

answer_method'' | 'hangup_others' required

Method to handle answered calls

Example request

{
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destinations": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "flow_id": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "ring_method": "ring_all",
  "answer_method": "hangup_others"
}

Response

The created groupcall details.

idstring uuid

The unique identifier of the group call.

customer_idstring uuid

The customer ID that owns this group call. Returned from the GET /customers response.

owner_typestring

Type of the resource owner (e.g., agent, queue).

owner_idstring uuid

The unique identifier of the resource owner. Returned from the corresponding owner resource endpoint (e.g., GET /agents, GET /queues).

status'progressing' | 'hangingup' | 'hangup'

Current status of the call or group call

flow_idstring uuid

The flow ID associated with this group call. Returned from the POST /flows or GET /flows response.

master_call_idstring uuid nullable

The unique identifier of the master call that initiated this group call. Returned from the POST /calls or GET /calls response.

master_groupcall_idstring uuid nullable

The unique identifier of the master group call, if applicable. Returned from the POST /groupcalls or GET /groupcalls response.

ring_method'' | 'ring_all' | 'linear'

Method used for dialing

answer_method'' | 'hangup_others'

Method to handle answered calls

answer_call_idstring uuid

The unique identifier of the answered call. Returned from the POST /calls or GET /calls response.

call_idsstring[]

List of associated call IDs. Each ID is returned from the POST /calls or GET /calls response.

answer_groupcall_idstring uuid

The unique identifier of the answered group call. Returned from the POST /groupcalls or GET /groupcalls response.

groupcall_idsstring[]

List of associated group call IDs. Each ID is returned from the POST /groupcalls or GET /groupcalls response.

call_countinteger

Number of remaining calls in the current dial.

groupcall_countinteger

Number of remaining group calls in the current dial.

dial_indexinteger nullable

Current dial index, valid only when the ring method is "ring_all".

tm_createstring date-time

The creation timestamp.

tm_updatestring date-time

The last update timestamp.

tm_deletestring date-time nullable

The deletion timestamp, if applicable.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "owner_type": "agent",
  "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  "status": "progressing",
  "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destinations": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  "master_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  "ring_method": "ring_all",
  "answer_method": "hangup_others",
  "answer_call_id": "550e8400-e29b-41d4-a716-446655440000",
  "call_ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "answer_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  "groupcall_ids": [
    "5e6f7a8b-9c0d-1234-ef01-234567890123"
  ],
  "call_count": 2,
  "groupcall_count": 1,
  "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

Changed in 3 of the 54 revisions of this API.425

  • d5569b31541122See the full diff
    • ●

      added the new web_session enum value to the destinations/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the new web_session enum value to the request property destinations/items/type

      request-property-enum-value-added

    • ○

      added the new web_session enum value to the request property source/type

      request-property-enum-value-added

  • bbde602eb17122See the full diff
    • ▲

      the actions request property's minItems was increased to 1

      request-property-min-items-increased

    • ▲

      the flow_id request property type/format changed from string/ to string/uuid

      request-property-type-changed

    • ○

      the request property actions became optional

      request-property-became-optional

    • ○

      the request property flow_id became optional

      request-property-became-optional

  • 995c56ba921921See the full diff
    • ▲

      the request property actions became required

      request-property-became-required

    • ▲

      the request property flow_id became required

      request-property-became-required

    • ○

      the flow_id request property type/format was generalized from string/uuid to string/

      request-property-type-generalized

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