Retrieve info for a specific Pool

RESPONSE PARAMETERS

KEY

DESCRIPTION

poolId

The tracking id of the pool.

poolName

The name of the pool.

smsSettings

The SMS settings of the pool.

smsSettings.sticky

When enabled, the service should try to always use the same number, as sender, for each recipient.

smsSettings.geomatch

When enabled, the service should try to use, as sender, a number that matches the destination country.

smsSettings.transcode

When enabled, the SMS message will get transcoded (when possible).

smsSettings.defaultCountry

A country code in ISO 3166-1 alpha-2 format. Routee will use a number from this defaultCountry as sender, if there is not a more suitable option (eg a number from the same country or a sticky sender for the recipient).

smsSettings.callback.url

A URL that Routee will POST to, each time your message status changes.

smsSettings.callback.strategy

Defines when the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion).

smsSettings.multipleSender

An array representing the settings required to support for multiple senderID's per country and multiple Keywords per ShortCode per country.

smsSettings.multipleSender.country

A country code in ISO 3166-1 alpha-2 format.

smsSettings.multipleSender.senderId

The senderID to use when the destination number matches the above country code.

smsSettings.multipleSender.keyword

A string representing the keyword to use for the OPT-OUT for the destination country.

smsSettings.multipleSender.shortCode

The shortCode to use for the OPT-OUT procedure for the destination country.

updatedAt

The timestamp the pool is updated.

totalNumbers

The total numbers of the pool.

Language