Resumes

Resumes records are generated when you are using the <Hold> verb. Those records are hosted with CPaaS and are available for you to retrieve.

The Resume records list resource represents a set of an account’s Resume records.

The Resumes API endpoint supports JSON output only.

Resumes Resource URI

/2012-04-24/Accounts/{AccountSid}/Resumes/{Sid}

Resource Properties

Property Description

Property	Description
api_version	The API version in use during the recording.
date_created	The date this record was created in RFC2822 format.
sid	A string that uniquely identifies this record.
org_sid	The unique id of the Organization which belongs to the Account.
account_sid	The unique id of the Account that created this record.
call_sid	The unique id of the call where the operation was executed.
status	The status of the resume procedure. Possible values are: resumed, failed, no-answer.
sip_response_code	The SIP response code received in response to the SIP re-INVITE request sent by CPaaS to the SIP endpoint. If the re-invite is not replied to and times out, the value will be 408.
uri	The URI for this record, relative to `\https://$DOMAIN/restcomm`.

api_version

The API version in use during the recording.

date_created

The date this record was created in RFC2822 format.

sid

A string that uniquely identifies this record.

org_sid

The unique id of the Organization which belongs to the Account.

account_sid

The unique id of the Account that created this record.

call_sid

The unique id of the call where the operation was executed.

status

The status of the resume procedure. Possible values are: resumed, failed, no-answer.

sip_response_code

The SIP response code received in response to the SIP re-INVITE request sent by CPaaS to the SIP endpoint. If the re-invite is not replied to and times out, the value will be 408.

uri

The URI for this record, relative to \https://$DOMAIN/restcomm.

Supported Operations

HTTP GET

Returns the representation of a Resume resource, including the properties above.

Listing a Single Hold Record

curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes/RMc377eb0e657e415383de087ab38797db  \
   -u 'YourAccountSid:YourAuthToken'

const request = require('request');

// Provide your Account Sid and Auth Token from your Console Account page
const ACCOUNT_SID = 'my_ACCOUNT_SID';
const AUTH_TOKEN = 'my_AUTH_TOKEN';

request({
      method: 'GET',
      url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes/RMc377eb0e657e415383de087ab38797db',
      auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN }
   },
   function (error, response, body) {
      // Add your business logic below; status can be found at 'response.statusCode' and response body at 'body'
      ...
   }
);

from http.client import HTTPSConnection
from base64 import b64encode

# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'

userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' %  userAndPass }

conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("GET", '/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes/RMc377eb0e657e415383de087ab38797db',
      headers=headers)
res = conn.getresponse()

# Add your business logic below; status can be found at 'res.status', reason at 'res.reason' and response body can be retrieved with res.read()
...

import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.util.Base64;

public class JavaSampleClass {
   // Provide your Account Sid and Auth Token from your Console Account page
   public static final String ACCOUNT_SID = "my_ACCOUNT_SID";
   public static final String AUTH_TOKEN = "my_AUTH_TOKEN";


   public static void main(String[] args) throws Exception {
      String userAndPass = ACCOUNT_SID + ':' + AUTH_TOKEN;
      String encoded = Base64.getEncoder().encodeToString(userAndPass.getBytes());

      URL url = new URL("https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes/RMc377eb0e657e415383de087ab38797db");
      HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
      conn.setRequestProperty("Authorization", "Basic " + encoded);
      conn.setRequestMethod("GET");

      // Add your business logic below; response code can be obtained from 'conn.getResponseCode()' and input stream from 'conn.getInputStream()'
      ...
  }
}

The response will be similar to the one below.

{
  "api_version": "2012-04-24",
  "sid": "RMc377eb0e657e415383de087ab38797db",
  "date_created": "2021-03-09T12:03:00.787Z",
  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "org_sid": "ORfe81fe8a3d5f4d5391e901db0bf5755d",
  "call_sid": "IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49",
  "status": "resumed",
  "sip_response_code": "200",
  "uri": "/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes/RMc377eb0e657e415383de087ab38797db"
}

Hold List Resource

Refers List Resource URI

/2012-04-24/Accounts/{AccountSid}/Resumes

Supported Operations

HTTP GET

Returns the list representation of all the Resume records resources for a given account, including the properties above.

Getting a List of Resume Records

curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes  \
   -u 'YourAccountSid:YourAuthToken'

const request = require('request');

// Provide your Account Sid and Auth Token from your Console Account page
const ACCOUNT_SID = 'my_ACCOUNT_SID';
const AUTH_TOKEN = 'my_AUTH_TOKEN';

request({
      method: 'GET',
      url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes',
      auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN }
   },
   function (error, response, body) {
      // Add your business logic below; status can be found at 'response.statusCode' and response body at 'body'
      ...
   }
);

from http.client import HTTPSConnection
from base64 import b64encode

# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'

userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' %  userAndPass }

conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("GET", '/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes',
      headers=headers)
res = conn.getresponse()

# Add your business logic below; status can be found at 'res.status', reason at 'res.reason' and response body can be retrieved with res.read()
...

import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.util.Base64;

public class JavaSampleClass {
   // Provide your Account Sid and Auth Token from your Console Account page
   public static final String ACCOUNT_SID = "my_ACCOUNT_SID";
   public static final String AUTH_TOKEN = "my_AUTH_TOKEN";


   public static void main(String[] args) throws Exception {
      String userAndPass = ACCOUNT_SID + ':' + AUTH_TOKEN;
      String encoded = Base64.getEncoder().encodeToString(userAndPass.getBytes());

      URL url = new URL("https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes");
      HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
      conn.setRequestProperty("Authorization", "Basic " + encoded);
      conn.setRequestMethod("GET");

      // Add your business logic below; response code can be obtained from 'conn.getResponseCode()' and input stream from 'conn.getInputStream()'
      ...
  }
}

The response will be similar to the one below.

{
 "page":0,
 "num_pages":0,
 "page_size":50,
 "total":34,
 "start":"0",
 "end":"34",
 "uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes",
 "first_page_uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes?Page=0&PageSize=50",
 "previous_page_uri":"null",
 "next_page_uri":"null",
 "last_page_uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes?Page=0&PageSize=50",
 "resumes":
    [
        {
            "api_version": "2012-04-24",
            "sid": "RMc377eb0e657e415383de087ab38797db",
            "date_created": "2021-03-09T12:03:00.787Z",
            "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "org_sid": "ORfe81fe8a3d5f4d5391e901db0bf5755d",
            "call_sid": "IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49",
            "status": "resumed",
            "sip_response_code": "200",
            "uri": "/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes/RMc377eb0e657e415383de087ab38797db"
        },
        ...
    ]
}

List Filter

HTTP GET

The following GET query string parameters allow you to limit the list returned.

Parameters are case-sensitive.

Request Parameters

Parameter	Description	Allowed values
Status	Filters records with a particular statues	resumed, failed, no-answer
SipResponseCode	Filters records that received a given SIP response code received in response to the SIP re-INVITE request sent to the SIP endpoint.	integer
StartTime	Filters records created on this date or later. Timezone is assumed to be UTC.	YYYY-MM-DDTHH:MM:SS (eg 2018-10-05T22:45:32) or YYYY-MM-DD (eg 2018-10-05)
EndTime	Filters records created on this date or earlier. Timezone is assumed to be UTC.	YYYY-MM-DDTHH:MM:SS (eg 2018-10-05T22:45:32) or YYYY-MM-DD (eg 2018-10-05)
CallSid	Filter records that were executed in the context of a Call	example: IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49

Parameter

Description

Allowed values

Status

Filters records with a particular statues

resumed, failed, no-answer

SipResponseCode

Filters records that received a given SIP response code received in response to the SIP re-INVITE request sent to the SIP endpoint.

integer

StartTime

Filters records created on this date or later. Timezone is assumed to be UTC.

YYYY-MM-DDTHH:MM:SS (eg 2018-10-05T22:45:32) or YYYY-MM-DD (eg 2018-10-05)

EndTime

Filters records created on this date or earlier. Timezone is assumed to be UTC.

YYYY-MM-DDTHH:MM:SS (eg 2018-10-05T22:45:32) or YYYY-MM-DD (eg 2018-10-05)

CallSid

Filter records that were executed in the context of a Call

example: IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49

Filtering by CallSid Parameter

The example below will return Resume records that have been executed for a particular Call.

curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes?CallSid=IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49  \
   -u 'YourAccountSid:YourAuthToken'

const request = require('request');

// Provide your Account Sid and Auth Token from your Console Account page
const ACCOUNT_SID = 'my_ACCOUNT_SID';
const AUTH_TOKEN = 'my_AUTH_TOKEN';

request({
      method: 'GET',
      url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes?CallSid=IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49',
      auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN }
   },
   function (error, response, body) {
      // Add your business logic below; status can be found at 'response.statusCode' and response body at 'body'
      ...
   }
);

from http.client import HTTPSConnection
from base64 import b64encode

# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'

userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' %  userAndPass }

conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("GET", '/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes?CallSid=IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49',
      headers=headers)
res = conn.getresponse()

# Add your business logic below; status can be found at 'res.status', reason at 'res.reason' and response body can be retrieved with res.read()
...

import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.util.Base64;

public class JavaSampleClass {
   // Provide your Account Sid and Auth Token from your Console Account page
   public static final String ACCOUNT_SID = "my_ACCOUNT_SID";
   public static final String AUTH_TOKEN = "my_AUTH_TOKEN";


   public static void main(String[] args) throws Exception {
      String userAndPass = ACCOUNT_SID + ':' + AUTH_TOKEN;
      String encoded = Base64.getEncoder().encodeToString(userAndPass.getBytes());

      URL url = new URL("https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes?CallSid=IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49");
      HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
      conn.setRequestProperty("Authorization", "Basic " + encoded);
      conn.setRequestMethod("GET");

      // Add your business logic below; response code can be obtained from 'conn.getResponseCode()' and input stream from 'conn.getInputStream()'
      ...
  }
}

The result will be similar to the one below

{
 "page":0,
 "num_pages":0,
 "page_size":50,
 "total":34,
 "start":"0",
 "end":"34",
 "uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes",
 "first_page_uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes?CallSid=IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49&Page=0&PageSize=50",
 "previous_page_uri":"null",
 "next_page_uri":"null",
 "last_page_uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes?CallSid=IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49&Page=0&PageSize=50",
 "resumes":
    [
        {
            "api_version": "2012-04-24",
            "sid": "RMc377eb0e657e415383de087ab38797db",
            "date_created": "2021-03-09T12:03:00.787Z",
            "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "org_sid": "ORfe81fe8a3d5f4d5391e901db0bf5755d",
            "call_sid": "IDbb44ef8c2ebf4d4599d0378a2a8a2ea8-CAd9e08ede8b604e739ba7d0bd477fdf49",
            "status": "resumed",
            "sip_response_code": "200",
            "uri": "/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Resumes/RMc377eb0e657e415383de087ab38797db"
        }
    ]
}

Paging Information

The request supports standard paging information. For more details, please visit the Paging Information documentation.