Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Page tools
On this page
Looking for more inspiration?Visit the

SenderPool Operations resource

SenderPool Operations represents an asynchronous request related to SenderPool resources. Use the operation ID to monitor the status and progress of a SenderPool operation.

Operation Properties

operation-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
idstring
required
Not PII

The Operation ID is an identifier that can be used to correlate all of the resources created in a request.

Issue a GET request to the resource list location, using the Operation ID as a query parameter to retrieve the resources that correlate with the Operation.

Example: comms_operation_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}
statusenum<string>
required
Not PII

The status of an Operation.

Possible values:
PROCESSINGCOMPLETEDCANCELED
statsSenderPoolOperationStats
required
Not PII
createdAtstring<date-time>
required
Not PII
updatedAtstring<date-time>
required
Not PII

Fetch a SenderPool Operation

fetch-a-senderpool-operation page anchor

GET https://comms.twilio.com/v1/SenderPools/Operations/{operationId}

Retrieve a SenderPool Operation by its ID.

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
operationIdstring
required
Not PII
Example: comms_operation_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}

Responses

responses page anchor
200400404409429500503

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
idstring

Optional

The Operation ID is an identifier that can be used to correlate all of the resources created in a request.

Issue a GET request to the resource list location, using the Operation ID as a query parameter to retrieve the resources that correlate with the Operation.

Example: comms_operation_01h9krwprkeee8fzqspvwy6nq8Pattern: ^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}
statusenum<string>

Optional

The status of an Operation.

Possible values:
PROCESSINGCOMPLETEDCANCELED
statsSenderPoolOperationStats

Optional

createdAtstring<date-time>

Optional

updatedAtstring<date-time>

Optional

Fetch a SenderPool OperationLink to code sample: Fetch a SenderPool Operation
1
import { TwilioClient } from "twilio-comms";

2


3
async function main() {

4
    const client = new TwilioClient({

5
        accountId: "TWILIO_ACCOUNT_SID",

6
        authToken: "TWILIO_AUTH_TOKEN",

7
    });

8
    await client.senderPools.fetchOperation("comms_operation_01h9krwprkeee8fzqspvwy6nq8");

9
}

10
main();

List SenderPool Operations

list-senderpool-operations page anchor

GET https://comms.twilio.com/v1/SenderPools/Operations

Retrieve a list of SenderPool Operations. Use query parameters to filter results by status and date range.

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
startDatestring<date-time>

Optional

Not PII

Filter to Operations created after the specified date and time in ISO 8601 format.

endDatestring<date-time>

Optional

Not PII

Filter to Operations created before the specified date and time in ISO 8601 format.

statusenum<string>

Optional

Not PII

Filter to Operations with the specified status.

Possible values:
PROCESSINGCOMPLETEDCANCELED
pageTokenstring

Optional

Not PII

The token to retrieve the next page of results.

pageSizeinteger

Optional

Not PII

The number of resources to return in a page.

Default: 50Example: 50Minimum: 1Maximum: 1000

Responses

responses-1 page anchor
200400409429500503

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
operationsarray[SenderPoolOperation]

Optional

A list of SenderPool Operations.

paginationPaginationMetadata

Optional

Metadata for paginated results. This object contains two tokens to navigate through paginated results.

  • Use next to retrieve the 'next' page in the result list.
  • Use self to retrieve the same page of the result list again.
  • Supply the token in the pageToken query param.
List SenderPool OperationsLink to code sample: List SenderPool Operations
1
import { TwilioClient } from "twilio-comms";

2


3
async function main() {

4
    const client = new TwilioClient({

5
        accountId: "TWILIO_ACCOUNT_SID",

6
        authToken: "TWILIO_AUTH_TOKEN",

7
    });

8
    await client.senderPools.listOperations({

9
        startDate: new Date("2024-01-15T09:30:00Z"),

10
        endDate: new Date("2024-01-15T09:30:00Z"),

11
        status: "PROCESSING",

12
        pageToken: "pageToken",

13
        pageSize: 50,

14
    });

15
}

16
main();