Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Rate this page:
On this page

Bundle Copies Resource

(information)

Info

This page is specifically about the Replace Items subresource of a Bundle. Please refer to Regulatory Compliance REST APIs for general knowledge or FAQ page.

With the new Bundle Copy resource, developers can now update their compliance information when Regulations change while they continue their Phone Number provisioning habits before the compliance information is no longer valid. The resource copies a Regulatory Bundle to allow updating of the compliance information in a mutable state.

Copies Response Properties

copies-response-properties page anchor

The field of the Bundle resource response is in JSON. The type SID<BU> is a unique ID starting with letters BU. For more information about Twilio SIDs, please refer to Twilio's glossary on SIDs.

Resource properties
sidtype: SID<BU>Not PII

The unique string that we created to identify the Bundle resource.

account_sidtype: SID<AC>Not PII

The SID of the Account(link takes you to an external page) that created the Bundle resource.

regulation_sidtype: SID<RN>Not PII

The unique string of a regulation that is associated to the Bundle resource.

friendly_nametype: stringNot PII

The string that you assigned to describe the resource.

statustype: enum<STRING>Not PII

The verification status of the Bundle resource.

Possible values:
draftpending-reviewin-reviewtwilio-rejectedtwilio-approvedprovisionally-approved
valid_untiltype: string<DATE TIME>Not PII

The date and time in GMT in ISO 8601(link takes you to an external page) format when the resource will be valid until.

emailtype: stringNot PII

The email address that will receive updates when the Bundle resource changes status.

status_callbacktype: string<URI>Not PII

The URL we call to inform your application of status changes.

date_createdtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.

date_updatedtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.

Bundle Statuses

bundle-statuses page anchor

The following statuses encompass the Bundle lifecycle.

StatusDescription
draftThe user has created a new Bundle that can be edited with Supporting Documents and End-User objects assigned.
pending-reviewWhen the user has finished the draft of the Bundle and submits to Twilio for review, the status moves from draft to pending-review.
in-reviewTwilio has moved the Bundle from pending-review to in-review. Once Twilio has finished review, the Bundle will go either to twilio-approved or twilio-rejected.
twilio-rejectedTwilio has reviewed the Bundle and has determined the Bundle does not meet the regulations.
twilio-approvedTwilio has reviewed the Bundle and has determined the Bundles does meet the regulations.

Create new Bundle Copy

create-new-bundle-copy page anchor
POST https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies

Parameters

create-parameters page anchor
URI parameters
BundleSidtype: SID<BU>Not PII
Path Parameter

The unique string that identifies the Bundle to be copied.

Request body parameters
FriendlyNametype: stringNot PII

The string that you assigned to describe the copied bundle.

Create new Bundle Copy

create-new-bundle-copy-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.numbers.v2.regulatoryCompliance
_12
.bundles('BUef3a237936fb63163fd852d77c5ba27b')
_12
.bundleCopies
_12
.create()
_12
.then(bundle_copy => console.log(bundle_copy.sid));

Output

_12
{
_12
"sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"regulation_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"friendly_name": "friendly_name",
_12
"status": "draft",
_12
"valid_until": "2015-07-30T20:00:00Z",
_12
"email": "email",
_12
"status_callback": "http://www.example.com",
_12
"date_created": "2015-07-30T20:00:00Z",
_12
"date_updated": "2015-07-30T20:00:00Z"
_12
}

Read multiple BundleCopy resources

read-multiple-bundlecopy-resources page anchor
GET https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies

Parameters

list-parameters page anchor
URI parameters
BundleSidtype: SID<BU>Not PII
Path Parameter

The unique string that we created to identify the Bundle resource.

PageSizetype: integerNot PII
Query Parameter

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Pagetype: integerNot PII
Query Parameter

The page index. This value is simply for client state.

PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

Read Regulatory Bundle

read-regulatory-bundle page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.numbers.v2.regulatoryCompliance
_12
.bundles('BUef3a237936fb63163fd852d77c5ba27b')
_12
.bundleCopies
_12
.list({limit: 20})
_12
.then(bundleCopies => bundleCopies.forEach(b => console.log(b.sid)));

Output

_25
{
_25
"results": [
_25
{
_25
"sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"regulation_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"friendly_name": "friendly_name",
_25
"status": "twilio-approved",
_25
"email": "email",
_25
"status_callback": "http://www.example.com",
_25
"valid_until": "2020-07-31T01:00:00Z",
_25
"date_created": "2019-07-30T22:29:24Z",
_25
"date_updated": "2019-07-31T01:09:00Z"
_25
}
_25
],
_25
"meta": {
_25
"page": 0,
_25
"page_size": 50,
_25
"first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Copies?PageSize=50&Page=0",
_25
"previous_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Copies?PageSize=50&Page=0",
_25
"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Copies?PageSize=50&Page=0",
_25
"next_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Copies?PageSize=50&Page=1",
_25
"key": "results"
_25
}
_25
}

Rate this page: