List or filter all dialer sessions | Close | Developer API Documentation

curl https://api.close.com/api/v1/dialer/ \
     -u "<CLOSE_API_KEY>:"

{
  "data": [
    {
      "caller_id": "",
      "date_created": "2018-07-17T12:35:01.230707",
      "date_updated": "2018-07-31T14:15:11.496227",
      "id": "dial_23eLaYZDjeL8tzFQMW5sto",
      "is_user_dependent": false,
      "music_preference": "tone1",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "ring_mode": "more-voicemails",
      "source_type": "saved-search",
      "source_value": "save_lch8hNQFbD9MgvMZbprURV715VVs1DEXSUl1xOA74p0",
      "status": "inactive",
      "type": "power",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "users": [
        {
          "is_active": false,
          "state": "inactive",
          "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
        }
      ]
    },
    {
      "caller_id": "+14356128874",
      "date_created": "2018-07-31T13:45:07.444155",
      "date_updated": "2018-07-31T13:45:42.875237",
      "id": "dial_4DejEkNkJOWj1jvqf5f6LO",
      "is_user_dependent": false,
      "music_preference": "tone1",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "ring_mode": "more-voicemails",
      "source_type": "saved-search",
      "source_value": "save_iKY1BB4HsI5Zzbgz3J20ycs8aPZK3Z9fq7rArkA85Gi",
      "status": "inactive",
      "type": "predictive",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "users": [
        {
          "is_active": false,
          "state": "inactive",
          "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
        }
      ]
    }
  ],
  "has_more": false
}

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

organization_idstring or nullOptional

source_typeenum or nullOptional

Allowed values:

source_valuestring or nullOptional

statusstring or nullOptional

status__instring or nullOptional

user_idstring or nullOptional

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error