JSON API » calls » calls/missed/list

Lists missed calls.

Input parameters

Requires authentication and the residential, user, or wholesale role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
startIntegerStart Unix timestamp.Recommended0
endIntegerEnd Unix timestamp.RecommendedNow.
dtypeStringDestination type. Empty string for any.RecommendedEmpty string.
dnumberStringDestination number. Empty string for any.RecommendedEmpty string.
cmatchStringWhat to match in the callerid. "exact", "contains", "start", or "end".No"contains"
cnumberStringThe callerid to match.NoEmpty string.
customerIntegerID of customer to get missed calls for.NoCustomer of authentication user.
sortStringField to sort by. "callerid" or "time".No"time"
descendingInteger1 to sort descending, 0 not to.No0

Failure to specify the start, end, dtype, and dnumber may put a heavy load on the database.

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your 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

VersionChanges
3.13Function added.