JSON API » calls » calls/missed/list
Lists missed calls.
Input parameters
Requires authentication and the residential, user, or wholesale role privileges.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
start | Integer | Start Unix timestamp. | Recommended | 0 |
end | Integer | End Unix timestamp. | Recommended | Now. |
dtype | String | Destination type. Empty string for any. | Recommended | Empty string. |
dnumber | String | Destination number. Empty string for any. | Recommended | Empty string. |
cmatch | String | What to match in the callerid. "exact", "contains", "start", or "end". | No | "contains" |
cnumber | String | The callerid to match. | No | Empty string. |
customer | Integer | ID of customer to get missed calls for. | No | Customer of authentication user. |
sort | String | Field to sort by. "callerid" or "time". | No | "time" |
descending | Integer | 1 to sort descending, 0 not to. | No | 0 |
Failure to specify the start, end, dtype, and dnumber may put a heavy load on the database.
Responses
Code | Description |
---|---|
200 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
403 | Your rate plan does not allow this. |
Data returned
An array of fields, one row for each missed call.
Example: With required and recommended parameters
http://enswitch.example.com/api/json/calls/missed/list/?auth_username=user;auth_password=password;start=1230000000;end=1240000000;dtype=phone;dnumber=1234567{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "time":1234567890, "callerid":"2125551234", ... }, { "time":1234567891, "callerid":"2125551234", ... } ] }
Change history
Version | Changes |
---|---|
3.14 | end input parameter changed to return data < value instead of <= value. |
3.13 | Function added. |