calls

Get a specific call by ID

Changed on

Retrieve detailed data about a specific terminated call by its ID. The response list array contains all log entries (CDR records) generated by this call — in case of call forwarding, transfer, or IVR routing, multiple entries will appear with distinct from_number/to_number or scenario_name/scenario_id.

Permission: Calls Read required.

Monitoring: This route can retrieve any team call regardless of the Monitoring flag. The Monitoring setting has no effect on call retrieval — the underlying stats service does not filter by user.

Summary, transcription and contact are included on every log. There is no expand parameter. summary or transcription is null when that call has no row. A failed download still returns the call (200) with error.code set on the field. contact is null when the call has no contact.

get/calls/{callId}

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/calls/{callId}
  • Auth
    API key in header Authorization

Path parameters

callIdstring required

The unique identifier of the call

Response

Successful operation

list_countinteger

The size of the array <em>list</em>, corresponds to the number of logs retrieved

Example response

{
  "list_count": 1,
  "list": [
    {
      "cdr_id": 19479175,
      "call_id": "9058220947198957713",
      "channel_id": "9058220947198957713",
      "type": "PHONE",
      "direction": "in",
      "last_state": "VOICEMAIL",
      "start_time": "2017-04-13T15:27:36+02:00",
      "answered_time": "2017-04-13T15:27:46+02:00",
      "end_time": "2017-04-13T15:27:56+02:00",
      "incall_duration": 10,
      "total_duration": 20,
      "from_number": "33600000000",
      "to_number": "33184800000",
      "note": "Potential client",
      "star": "STAR1",
      "tags": [
        {
          "tag_id": 123,
          "name": "mytag",
          "color": "ff6b6b",
          "description": "my tag description",
          "creation_date": "2018-08-12T12:12:40.53Z"
        }
      ],
      "record": "https://cdn.ringover.com/records/0-0/35537d8679f3e2-13-04-19-15h27-33600000000-33180800000.mp3",
      "user": {
        "user_id": 123456,
        "team_id": 123456,
        "initial": "PM",
        "color": "3CC8C8",
        "firstname": "Pauline",
        "lastname": "Martin",
        "company": "Ringover",
        "email": "pauline.martin@ringover.com",
        "picture": "https://cdn77.ringover.com/img/users/default.jpg",
        "concat_name": "Pauline Martin"
      },
      "conference": {
        "conference_id": 60908,
        "name": "SoConference",
        "numbers": [
          {
            "number": 33184800000,
            "label": "myfavoritenumber",
            "type": "PHONE",
            "user_id": 60907,
            "ivr_id": 60908,
            "conference_id": 60908,
            "format": {
              "raw": 184800000,
              "country_code": "33",
              "country": "FR",
              "e164": "+33184800000",
              "international": "+33 1 84 80 00 00",
              "international_alt": "33184800000",
              "national": "01 84 80 00 00",
              "national_alt": "0184800000",
              "rfc3966": "tel:+33-1-84-80-00-00"
            }
          }
        ]
      },
      "ivr": {
        "ivr_id": 123456,
        "name": "StandardFacile",
        "color": "ff6b6b"
      },
      "contact": {
        "contact_id": 654321,
        "is_shared": true,
        "social_service_id": "00P7U000015Ei75YBX",
        "firstname": "John",
        "lastname": "Do",
        "company": "DoeCompany",
        "concat_name": "John Doe",
        "color": "3CC8C8",
        "initial": "JD",
        "creation_date": "2018-08-12T12:12:40.53Z",
        "numbers": [
          331797500010
        ]
      }
    }
  ]
}

Changes

    • breaking

      added subschema #2 to the // response property oneOf list for the response status

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

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

    • info

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

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id getCallsCallid was added

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status