Grandstream Networks UCM6100 Series Cdr And Rec Api Manual

Grandstream Networks UCM6100 Series Cdr And Rec Api Manual

Ip pbx appliance
Hide thumbs Also See for UCM6100 Series:

Advertisement

Quick Links

Grandstream Networks, Inc.
UCM6100 Series IP PBX Appliance
CDR and REC API Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the UCM6100 Series and is the answer not in the manual?

Questions and answers

Summary of Contents for Grandstream Networks UCM6100 Series

  • Page 1 Grandstream Networks, Inc. UCM6100 Series IP PBX Appliance CDR and REC API Guide...
  • Page 2: Table Of Contents

    EXAMPLE OUTPUT ..........................13 CSV............................... 13 XML............................... 13 JSON ............................14 REC API – ACCESS CALL RECORDING FILES ........15 REC API URL FORMAT ........................15 REC API URL PARAMETERS ......................15 UCM6100 Series CDR and REC API Guide Page 1 of 17...
  • Page 3 Figure 5: Downloaded CDR File Sample - Source Channel and Dest Channel 2 ........7 Figure 6: Downloaded CDR File Sample - Source Channel and Dest Channel 3 ........7 UCM6100 Series CDR and REC API Guide Page 2 of 17...
  • Page 4: Cdr Report

    CDR FILTER On the UCM6100 series, the CDR can be accessed under web UI->Status->CDR->CDR. Users could filter the call report by specifying the date range and criteria, depending on how the users would like to include the logs to the report. Then click on "View Report" button to display the generated report.
  • Page 5: Cdr Report Data Fields

    6005 7080 [Trunk: CallCenterTrunk]  Answered By Example format: 6005 trunk_16  Call Time Format: 0:13:45  Talk Time Format: 0:13:41  Status No answer, Busy, Answered, or Failed. UCM6100 Series CDR and REC API Guide Page 4 of 17...
  • Page 6: Cdr Report Operations

    The following figure shows CDR record produced by the UCM6100 series. Figure 2: CDR Report CDR REPORT OPERATIONS Users could perform the following operations on the above CDR report.  Sort Click on the header of the column to sort by this category. For example, clicking on "Start Time" will sort the report according to start time.
  • Page 7: Cdr Csv File

     Source Channel, Dest Channel Sample 1: Figure 4: Downloaded CDR File Sample - Source Channel and Dest Channel 1 UCM6100 Series CDR and REC API Guide Page 6 of 17...
  • Page 8: Figure 5: Downloaded Cdr File Sample - Source Channel And Dest Channel 2

    Playback: play some prompts to you, such as 183 response or run into an IVR. ReadExten: collect numbers from user. It may occur when you input PIN codes or run into DISA UCM6100 Series CDR and REC API Guide Page 7 of 17...
  • Page 9: Api Configuration

    Multiple entries are allowed. Permitted IP(s) For example, "192.168.40.3/255.255.255.255" denies access from all IP addresses except 192.168.40.3. The default setting is blank, meaning all IP addresses will be denied. UCM6100 Series CDR and REC API Guide Page 8 of 17...
  • Page 10: Cdr Api - Access Call Detail Records

    Number of matching records to skip. This will be combined with numRecords to receive all matches offset Number over multiple responses. Default is 0. UCM6100 Series CDR and REC API Guide Page 9 of 17...
  • Page 11: Example Queries

    Filters based on the billsec value, the duration Number (duration in seconds) between call answer and call end. maxDur EXAMPLE QUERIES The following illustrates the format of queries to accomplish certain requests. In most cases, multiple UCM6100 Series CDR and REC API Guide Page 10 of 17...
  • Page 12: Ucm6100 Series Cdr And Rec Api Guide

    Query 4: Request all records of calls placed by an Anonymous caller during July 2013 Central Standard Time to extensions starting with 2 or 34 or ending with 5, with results in CSV format. https://192.168.254.200:8088/cdrapi?caller=Anonymous&callee=2@,34@,@5&startTime=2013-07-01T00:00:00- 06:00&endTime=2013-07-31T23:59:59-06:00 UCM6100 Series CDR and REC API Guide Page 11 of 17...
  • Page 13: Ucm6100 Series Cdr And Rec Api Guide

    - Extension values starting with comma, or with consecutive commas (e.g. caller=5300,,5303) - Unknown parameters (e.g. caler=5300) or URI ending with '&' - Except for caller and callee, multiple instances of the same parameter within the URI (e.g. minDur=5&minDur=10) UCM6100 Series CDR and REC API Guide Page 12 of 17...
  • Page 14: Example Output

    11:46:40</start><answer>2013-12-03 11:46:43</answer><end>2013-12-03 11:46:49</end><duration>9</duration><billsec>6</billsec><disposition>ANSWERED</disposition><a maflags>DOCUMENTATION</amaflags><uniqueid>1386092800.0</uniqueid><userfield>EXT</userfi eld><channel_ext>5300</channel_ext><dstchannel_ext>5301</dstchannel_ext><service>s</service> </cdr> <cdr><AcctId>63</AcctId><accountcode></accountcode><src>5300</src><dst>5301</dst><dcontext >from-internal</dcontext><clid>&quot;pn01&quot; &lt;5300&gt;</clid><channel>SIP/5300- 00000000</channel><dstchannel>SIP/5301- 00000001</dstchannel><lastapp>Dial</lastapp><lastdata>SIP/5301,60,</lastdata><start>2013-12-03 14:01:41</start><answer>2013-12-03 14:01:43</answer><end>2013-12-03 14:01:46</end><duration>5</duration><billsec>3</billsec><disposition>ANSWERED</disposition><a maflags>DOCUMENTATION</amaflags><uniqueid>1386100901.0</uniqueid><userfield>EXT</userfi eld><channel_ext>5300</channel_ext><dstchannel_ext>5301</dstchannel_ext><service>s</service> </cdr> <cdr><AcctId>64</AcctId><accountcode></accountcode><src>5300</src><dst>5301</dst><dcontext >from-internal</dcontext><clid>&quot;pn01&quot; &lt;5300&gt;</clid><channel>SIP/5300- 00000002</channel><dstchannel>SIP/5301- 00000003</dstchannel><lastapp>Dial</lastapp><lastdata>SIP/5301,60,</lastdata><start>2013-12-03 14:02:23</start><answer>2013-12-03 14:02:27</answer><end>2013-12-03 14:02:31</end><duration>8</duration><billsec>4</billsec><disposition>ANSWERED</disposition><a maflags>DOCUMENTATION</amaflags><uniqueid>1386100943.2</uniqueid><userfield>EXT</userfi eld><channel_ext>5300</channel_ext><dstchannel_ext>5301</dstchannel_ext><service>s</service> </cdr> UCM6100 Series CDR and REC API Guide Page 13 of 17 </root>...
  • Page 15: Json

    "Dial", "lastdata": "SIP/5301,60,", "start": "2013-12-03 14:02:23", "answer": "2013-12-03 14:02:27", "end": "2013-12-03 14:02:31", "duration": "8", "billsec": "4", "disposition": "ANSWERED", "amaflags": "DOCUMENTATION", "uniqueid": "1386100943.2", "userfield": "EXT", "channel_ext": "5300", "dstchannel_ext": "5301", "service": "s" } UCM6100 Series CDR and REC API Guide Page 14 of 17...
  • Page 16: Rec Api - Access Call Recording Files

    Response: A CSV file listing all directories under ast_config_AST_SPOOL_DIR. Case 2: Only filedir is set. In this case, multiple file directories are supported, separated by '@'. Example Request: UCM6100 Series CDR and REC API Guide Page 15 of 17...
  • Page 17: Ucm6100 Series Cdr And Rec Api Guide

    Case 4: Only filename is set. This case is the same as Case 3, with the file directory defaulting to “monitor”. Example Request: https://192.168.254.200:8443/recapi?filename=auto-1414771234-1000-1004.wav@auto-1414775678-1001- 1003.wav Response: See Case 3. UCM6100 Series CDR and REC API Guide Page 16 of 17...
  • Page 18 File names longer than 256 characters will be truncated.  File names containing ' ' (space) or '..' will be skipped. This document can be downloaded here: http://www.grandstream.com/products/ucm_series/ucm61xx/documents/ucm61xx_cdr_rec_api_guide.pdf * Asterisk is a Registered Trademark of Digium, Inc. UCM6100 Series CDR and REC API Guide Page 17 of 17...

Table of Contents