api:sip:getdialog
Table of Contents
API : SIP Dialog
Introduction
This request will return historic SIP dialog data for a given period of time, for use in debugging.
Dialog is kept for 14 days in 1 hours .zip packages for each SIP account.
Alternativly you may also use the realtime function for monitoring the SIP dialog in realtime.
Request
| URL | https://api.telecomx.dk/sip/ACCOUNT_ID/dialog | |
|---|---|---|
| Method | GET | |
| Access level | OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Param | ACCOUNT_ID | Id of the SIP account (24 hex-char string). |
| Query | date | [optional] Date and time (hour) for the hour to return SIP dialog records. Date format: yyyy-MM-ddTHH:mm:ss.mmmZ. Defaults to today at the current hour. Only the date and hour is used as SIP dialog data is packaged in 1 hour blocks. |
Query example
https://api.telecomx.dk/sip/1234567890ABCDEF12345678/dialog https://api.telecomx.dk/sip/1234567890ABCDEF12345678/dialog?date=2014-07023T14:00:00.000Z
Response
| JSON object | |
|---|---|
| link | a URL to call, for downloading the SIP dialog. |
Example
{ link: 'https://log.telecomx.dk/1234567890ABCDEF1234578/2014072314' }
To use the link returned, you must add your token for authentication like this:
https://log.telecomx.dk/1234567890ABCDEF1234578/2014072314?token=dfhjkeqwufsdjkfbsegfiueghfjkbewjkhfgiweufghkj
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | SIP account id not found in request URI |
| 404 | sipAccount | SIP account not found |
| 403 | access_denied | Insufficient access level |
| 404 | date | Date not found, invalid or no dialog found |
api/sip/getdialog.txt · Last modified: 2014/05/23 12:51 by Per Møller