HTTP API - Get CDR - Revision history

Administrator at 12:48, 5 May 2024

2024-05-05T12:48:18Z

← Older revision		Revision as of 12:48, 5 May 2024
Line 75:		Line 75:

	'''Response:'''		'''Response:'''

	{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","cdr":[{"port":2, "start_date":"2015-07-21 16:35:20","answer_date":"2015-07-21 16:35:31","duration":3,"source_number":"1010","destination_num ber":"6717","direction":"ip->gsm","ip":"172.16.100.136","codec":"G.711U","hangup":"called","gsm_code":16,"bcch":""}]}		{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","cdr":[{"port":2, "start_date":"2015-07-21 16:35:20","answer_date":"2015-07-21 16:35:31","duration":3,"source_number":"1010","destination_num ber":"6717","direction":"ip->gsm","ip":"172.16.100.136","codec":"G.711U","hangup":"called","gsm_code":16,"bcch":""}]}

Administrator: /* Response： */

2024-05-05T12:47:27Z

Response：

← Older revision		Revision as of 12:47, 5 May 2024
Line 74:		Line 74:
	curl -k --anyauth -u admin:admin -d '{"port":[2,3]}' -H "Content-Type: application/json" <nowiki>http://gateway_ip/api/get_cdr</nowiki>		curl -k --anyauth -u admin:admin -d '{"port":[2,3]}' -H "Content-Type: application/json" <nowiki>http://gateway_ip/api/get_cdr</nowiki>

	~~====== Response： ======~~		'''Response:'''
	{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","cdr":[{"port":2, "start_date":"2015-07-21 16:35:20","answer_date":"2015-07-21 16:35:31","duration":3,"source_number":"1010","destination_num ber":"6717","direction":"ip->gsm","ip":"172.16.100.136","codec":"G.711U","hangup":"called","gsm_code":16,"bcch":""}]}		{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","cdr":[{"port":2, "start_date":"2015-07-21 16:35:20","answer_date":"2015-07-21 16:35:31","duration":3,"source_number":"1010","destination_num ber":"6717","direction":"ip->gsm","ip":"172.16.100.136","codec":"G.711U","hangup":"called","gsm_code":16,"bcch":""}]}

Administrator at 12:46, 5 May 2024

2024-05-05T12:46:05Z

← Older revision		Revision as of 12:46, 5 May 2024
Line 1:		Line 1:
	~~Request~~
	'''POST <nowiki>https://gateway_ip/api/get_cdr</nowiki>'''		'''POST <nowiki>https://gateway_ip/api/get_cdr</nowiki>'''

	Request ~~Parameter~~		'''Request Parameters:'''
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
Line 31:		Line 30:
	\|}		\|}

	Response ~~Parameter~~		'''Response Parameters:'''
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
Line 50:		Line 49:
	\|Array		\|Array
	\|Each CDR will be returned according to the query.		\|Each CDR will be returned according to the query.
	\|}		'''port''': port number;


	~~{\| class="wikitable"~~
	\|
	\|
	\|'''port''': port number;

	'''start_date''': start time of the call; '''answer_date''': answer time of the call; '''duration''': call duration '''source_number'''：source number		'''start_date''': start time of the call; '''answer_date''': answer time of the call; '''duration''': call duration '''source_number'''：source number
Line 75:		Line 68:
	\|}		\|}

	Example of Getting CDR		'''Example of Getting CDR:'''

			'''Request：'''

	~~Request：~~
	curl -k --anyauth -u admin:admin -d '{"port":[2,3]}' -H "Content-Type: application/json" <nowiki>http://gateway_ip/api/get_cdr</nowiki>		curl -k --anyauth -u admin:admin -d '{"port":[2,3]}' -H "Content-Type: application/json" <nowiki>http://gateway_ip/api/get_cdr</nowiki>

	====== Response： ======		====== Response： ======
	{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","cdr":[{"port":2, "start_date":"2015-07-21 16:35:20","answer_date":"2015-07-21 16:35:31","duration":3,"source_number":"1010","destination_num ber":"6717","direction":"ip->gsm","ip":"172.16.100.136","codec		{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","cdr":[{"port":2, "start_date":"2015-07-21 16:35:20","answer_date":"2015-07-21 16:35:31","duration":3,"source_number":"1010","destination_num ber":"6717","direction":"ip->gsm","ip":"172.16.100.136","codec":"G.711U","hangup":"called","gsm_code":16,"bcch":""}]}

	":"G.711U","hangup":"called","gsm_code":16,"bcch":""}]}

Administrator at 12:43, 5 May 2024

2024-05-05T12:43:36Z

← Older revision		Revision as of 12:43, 5 May 2024
Line 1:		Line 1:
	~~==== 9.1~~ Request ~~====~~		Request
	'''POST <nowiki>https://gateway_ip/api/get_cdr</nowiki>'''		'''POST <nowiki>https://gateway_ip/api/get_cdr</nowiki>'''

	~~==== 9.2~~ Request Parameter ~~====~~		Request Parameter
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
Line 31:		Line 31:
	\|}		\|}

	~~==== 9.3~~ Response Parameter ~~====~~		Response Parameter
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Parameter'''		\|'''Parameter'''
Line 75:		Line 75:
	\|}		\|}

	~~==== 9.4~~ Example of Getting CDR ~~====~~		Example of Getting CDR

	~~======~~ Request： ~~======~~		Request：
	curl -k --anyauth -u admin:admin -d '{"port":[2,3]}' -H "Content-Type: application/json" <nowiki>http://gateway_ip/api/get_cdr</nowiki>		curl -k --anyauth -u admin:admin -d '{"port":[2,3]}' -H "Content-Type: application/json" <nowiki>http://gateway_ip/api/get_cdr</nowiki>

Administrator: Created page with "==== 9.1 Request ==== '''POST https://gateway_ip/api/get_cdr''' ==== 9.2 Request Parameter ==== {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- | colspan="3" |'''Optional Parameter''' |- |port |Array |Port(s) whose CDR is to be queried; Each port number should be an integer ranging from 0 to 31. |- |time_after |String |String like "YYYY-MM-DD HH:MM:SS"; Query t..."

2024-05-02T22:26:38Z

Created page with "==== 9.1 Request ==== '''POST <nowiki>https://gateway_ip/api/get_cdr</nowiki>''' ==== 9.2 Request Parameter ==== {| class="wikitable" |'''Parameter''' |'''Type''' |'''Description''' |- | colspan="3" |'''Required Parameter''' |- | colspan="3" |'''Optional Parameter''' |- |port |Array |Port(s) whose CDR is to be queried; Each port number should be an integer ranging from 0 to 31. |- |time_after |String |String like "YYYY-MM-DD HH:MM:SS"; Query t..."

New page

==== 9.1 Request ====
'''POST <nowiki>https://gateway_ip/api/get_cdr</nowiki>'''

==== 9.2 Request Parameter ====
{| class="wikitable"
|'''Parameter'''
|'''Type'''
|'''Description'''
|-
| colspan="3" |'''Required Parameter'''
|-
| colspan="3" |'''Optional Parameter'''
|-
|port
|Array
|Port(s) whose CDR is to be queried;

Each port number should be an integer ranging from 0 to 31.
|-
|time_after
|String
|String like "YYYY-MM-DD HH:MM:SS";

Query the CDRs which are sent after this time.
|-
|time_before
|String
|String like "YYYY-MM-DD HH:MM:SS";

Query CDRs are sent before this time.
|}

==== 9.3 Response Parameter ====
{| class="wikitable"
|'''Parameter'''
|'''Type'''
|'''Description'''
|-
|error_code
|Integer
|Codes that may be returned: 200: Request has been processed 400: Request format is not valid

500: Other errors
|-
|sn
|String
|SN of the gateway
|-
|cdr
|Array
|Each CDR will be returned according to the query.
|}

{| class="wikitable"
|
|
|'''port''': port number;

'''start_date''': start time of the call; '''answer_date''': answer time of the call; '''duration''': call duration '''source_number'''：source number

'''destination_number'''：destination number

'''direction''': call direction which could be gsm->ip, ip->gsm or callback;

'''ip''': the source ip of an ip->gsm call

'''codec''': it could be：G.711U, G.723.1, G.711A or G.729AB;

'''hangup''': the party to hang up the call ; it could be the called party, the calling party or the gateway;

'''gsm_code''': the code of the reason why the GSM side hangs up the call;

'''bcch''': BCCH used for this call
|}

==== 9.4 Example of Getting CDR ====

====== Request： ======
curl -k --anyauth -u admin:admin -d '{"port":[2,3]}' -H "Content-Type: application/json" <nowiki>http://gateway_ip/api/get_cdr</nowiki>

====== Response： ======
{"error_code":200,"sn":"xxxx-xxxx-xxxx-xxxx","cdr":[{"port":2, "start_date":"2015-07-21 16:35:20","answer_date":"2015-07-21 16:35:31","duration":3,"source_number":"1010","destination_num ber":"6717","direction":"ip->gsm","ip":"172.16.100.136","codec

":"G.711U","hangup":"called","gsm_code":16,"bcch":""}]}