Bundle Copies Resource
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.
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.
The unique string that we created to identify the Bundle resource.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Account that created the Bundle resource.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The unique string of a regulation that is associated to the Bundle resource.
^RN[0-9a-fA-F]{32}$Min length: 34Max length: 34The verification status of the Bundle resource.
draftpending-reviewin-reviewtwilio-rejectedtwilio-approvedprovisionally-approvedThe date and time in GMT in ISO 8601 format when the resource will be valid until.
The email address that will receive updates when the Bundle resource changes status.
The URL we call to inform your application of status changes.
The date and time in GMT when the resource was created specified in ISO 8601 format.
The following statuses encompass the Bundle lifecycle.
| Status | Description |
|---|---|
| draft | The user has created a new Bundle that can be edited with Supporting Documents and End-User objects assigned. |
| pending-review | When the user has finished the draft of the Bundle and submits to Twilio for review, the status moves from draft to pending-review. |
| in-review | Twilio 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-rejected | Twilio has reviewed the Bundle and has determined the Bundle does not meet the regulations. |
| twilio-approved | Twilio has reviewed the Bundle and has determined the Bundles does meet the regulations. |
POST https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies
The unique string that identifies the Bundle to be copied.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34application/x-www-form-urlencodedThe string that you assigned to describe the copied bundle.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createBundleCopy() {11const bundleCopy = await client.numbers.v2.regulatoryCompliance12.bundles("BUef3a237936fb63163fd852d77c5ba27b")13.bundleCopies.create();1415console.log(bundleCopy.sid);16}1718createBundleCopy();
Response
1{2"sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",4"regulation_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"friendly_name": "friendly_name",6"status": "draft",7"valid_until": "2015-07-30T20:00:00Z",8"email": "email",9"status_callback": "http://www.example.com",10"date_created": "2015-07-30T20:00:00Z",11"date_updated": "2015-07-30T20:00:00Z"12}
GET https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies
The unique string that we created to identify the Bundle resource.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34How many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listBundleCopy() {11const bundleCopies = await client.numbers.v2.regulatoryCompliance12.bundles("BUef3a237936fb63163fd852d77c5ba27b")13.bundleCopies.list({ limit: 20 });1415bundleCopies.forEach((b) => console.log(b.sid));16}1718listBundleCopy();
Response
1{2"results": [],3"meta": {4"page": 0,5"page_size": 50,6"first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0",7"previous_page_url": null,8"url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Copies?PageSize=50&Page=0",9"next_page_url": null,10"key": "results"11}12}