Mobile Messaging Exchange - CDR Report API

{"swagger":"2.0","info":{"version":"1.0","title":"Mobile Messaging Exchange - CDR Report API"},"paths":{"/CDR/account/{accountId}":{"get":{"tags":["TOP 25 CDR by account Id & Time Frame"],"summary":"message logs for a specific account Id & time frame","operationId":"top_25_cdr","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"This is the customer account id assigned to the customer at the time of onboarding. User can specify one or more custAccountId.","required":true,"type":"string"},{"name":"fromDate","in":"query","description":"This is the from date in format of dd-MM-yyyy HH:mm:SS (Ex. 03-03-2020 07:09:00) which customer account usage is available for usage report.","required":true,"type":"string"},{"name":"toDate","in":"query","description":"This is the to date in in format of dd-MM-yyyy HH:mm:SS (Ex. 03-03-2020 07:09:00) which customer account usage is available for usage report.","required":true,"type":"string"},{"name":"pageNo","in":"query","description":"Skip Number of records for paging","required":false,"type":"number","default":0.0},{"name":"pageSize","in":"query","description":"Number of records to return","required":false,"type":"number","default":25.0}],"responses":{"200":{"description":"Successfully retrieved data.","schema":{"$ref":"#/definitions/OutputList"}},"400":{"description":"Request is semantically incorrect or missing required parameters. | Error: CDRs for the selected period are not loaded because the SMS retry period of 72 hours is not completed","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/CDR/message/{messageId}":{"get":{"tags":["CDR by Customer Message Id"],"summary":"message logs for a message ID","operationId":"cdr_by_messageId","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"This is the customer Message Id.","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved data.","schema":{"$ref":"#/definitions/SuccessResponse"}},"400":{"description":"Request is semantically incorrect or missing required parameters. | Error: CDRs for the selected period are not loaded because the SMS retry period of 72 hours is not completed","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponse"}}}}}},"definitions":{"SuccessResponse":{"properties":{"requestTime":{"type":"string","example":"2018-08-22T06:05:00+00:00","description":"This is the time when request is come to the MMX Hub."},"lastDeliveredTime":{"type":"string","example":"2018-08-22T06:05:00+00:00","description":"This is the Last delivered time."},"messageId":{"type":"string","example":"b94ef907-7778-442c-9743-fe02238c6977","description":"This is the internal unique Message Id."},"accountId":{"type":"string","example":"35317-2","description":"This is the customer account id assigned to the customer at the time of onboarding. User can specify one or more custAccountId."},"destinationId":{"type":"string","example":"1-245-0","description":"This is the destination vpc"},"destinationCountry":{"type":"string","example":"unknown","description":"This is the destination Country"},"destinationAddress":{"type":"string","example":"919961986196","description":"This is the Destination Address."},"originatingAddress":{"type":"string","example":"LNKDIN","description":"This is the Originating Address."},"attemptedStatus":{"type":"string","example":"Success","description":"This is the status of attempted message."},"submittedStatus":{"type":"string","example":"Success","description":"This is the status of submitted message."},"deliveredStatus":{"type":"string","example":"Success","description":"This is the status of delivered message."},"errorCode":{"type":"number","example":0.0,"description":"This is the error code."},"errorDescription":{"type":"string","example":"Success","description":"This is the error description."}}},"ErrorResponse":{"properties":{"status":{"type":"string","description":"Http status of the response"},"message":{"type":"string","description":"Error description"}}},"OutputList":{"properties":{"totalItems":{"type":"number","example":100.0,"description":"Total No. of Items available"},"displayItems":{"type":"number","example":25.0,"description":"Total No. of Items displayed"},"items":{"type":"array","items":{"$ref":"#/definitions/SuccessResponse"}}}}}}