Returns a list of your outbound profiles.
Outbound Profile response
Unauthorized
[- {
- "id": "string",
- "user_id": "string",
- "connections": [
- { }
], - "name": null,
- "traffic_type": 1,
- "service_plan": 4,
- "cps_limit": 100,
- "ports": 0,
- "translation_rule": "string",
- "active": true,
- "cps_limit_increase": 0,
- "tag_list": [
- "string"
], - "usage_payment_method": "rate-deck",
- "custom_rate_deck": false,
- "rate_deck_url": "string",
- "whitelisted_destination_format": "alpha2",
- "whitelisted_destinations": [
- "US",
- "BR",
- "AU"
], - "max_destination_rate": 0,
- "connection_id": "string",
- "call_recording_type": "all",
- "call_recording_phone_numbers": [
- "string"
], - "call_recording_format": "wav",
- "call_recording_channels": "single",
- "daily_spend_limit": "string",
- "daily_spend_limit_enabled": false,
- "billing_group_id": "string"
}
]
Creates a new outbound profile object.
Outbound Profile to add
Outbound Profile created response
Bad request
Unauthorized
{- "connection_ids": [
- "string"
], - "name": "string",
- "traffic_type": 1,
- "service_plan": 4,
- "active": true,
- "translation_rule": "string",
- "cps_limit_increase": 0,
- "ports": 0,
- "tag_list": [
- "string"
], - "usage_payment_method": "rate-deck",
- "whitelisted_destination_format": "alpha2",
- "whitelisted_destinations": [
- "US",
- "BR",
- "AU"
], - "max_destination_rate": 0,
- "call_recording_type": "all",
- "call_recording_phone_numbers": [
- "string"
], - "call_recording_format": "wav",
- "call_recording_channels": "single",
- "daily_spend_limit": "string",
- "daily_spend_limit_enabled": false,
- "billing_group_id": "string"
}
{- "id": "string",
- "user_id": "string",
- "connections": [
- { }
], - "name": null,
- "traffic_type": 1,
- "service_plan": 4,
- "cps_limit": 100,
- "ports": 0,
- "translation_rule": "string",
- "active": true,
- "cps_limit_increase": 0,
- "tag_list": [
- "string"
], - "usage_payment_method": "rate-deck",
- "custom_rate_deck": false,
- "rate_deck_url": "string",
- "whitelisted_destination_format": "alpha2",
- "whitelisted_destinations": [
- "US",
- "BR",
- "AU"
], - "max_destination_rate": 0,
- "connection_id": "string",
- "call_recording_type": "all",
- "call_recording_phone_numbers": [
- "string"
], - "call_recording_format": "wav",
- "call_recording_channels": "single",
- "daily_spend_limit": "string",
- "daily_spend_limit_enabled": false,
- "billing_group_id": "string"
}
Retrieves the details of an existing outbound profile.
Outbound Profile record response
Unauthorized
Resource not found
{- "id": "string",
- "user_id": "string",
- "connections": [
- { }
], - "name": null,
- "traffic_type": 1,
- "service_plan": 4,
- "cps_limit": 100,
- "ports": 0,
- "translation_rule": "string",
- "active": true,
- "cps_limit_increase": 0,
- "tag_list": [
- "string"
], - "usage_payment_method": "rate-deck",
- "custom_rate_deck": false,
- "rate_deck_url": "string",
- "whitelisted_destination_format": "alpha2",
- "whitelisted_destinations": [
- "US",
- "BR",
- "AU"
], - "max_destination_rate": 0,
- "connection_id": "string",
- "call_recording_type": "all",
- "call_recording_phone_numbers": [
- "string"
], - "call_recording_format": "wav",
- "call_recording_channels": "single",
- "daily_spend_limit": "string",
- "daily_spend_limit_enabled": false,
- "billing_group_id": "string"
}
Updates the specified outbound profile with the values of the parameters passed. Any parameters not included in the request will be left unchanged.
Updated Outbound Profile object
Outbound Profile updated response
Bad request
Unauthorized
{- "connection_ids": [
- "string"
], - "name": "string",
- "traffic_type": 1,
- "service_plan": 4,
- "active": true,
- "translation_rule": "string",
- "cps_limit_increase": 0,
- "ports": 0,
- "tag_list": [
- "string"
], - "usage_payment_method": "rate-deck",
- "whitelisted_destination_format": "alpha2",
- "whitelisted_destinations": [
- "US",
- "BR",
- "AU"
], - "max_destination_rate": 0,
- "call_recording_type": "all",
- "call_recording_phone_numbers": [
- "string"
], - "call_recording_format": "wav",
- "call_recording_channels": "single",
- "daily_spend_limit": "string",
- "daily_spend_limit_enabled": false,
- "billing_group_id": "string"
}
{- "id": "string",
- "user_id": "string",
- "connections": [
- { }
], - "name": null,
- "traffic_type": 1,
- "service_plan": 4,
- "cps_limit": 100,
- "ports": 0,
- "translation_rule": "string",
- "active": true,
- "cps_limit_increase": 0,
- "tag_list": [
- "string"
], - "usage_payment_method": "rate-deck",
- "custom_rate_deck": false,
- "rate_deck_url": "string",
- "whitelisted_destination_format": "alpha2",
- "whitelisted_destinations": [
- "US",
- "BR",
- "AU"
], - "max_destination_rate": 0,
- "connection_id": "string",
- "call_recording_type": "all",
- "call_recording_phone_numbers": [
- "string"
], - "call_recording_format": "wav",
- "call_recording_channels": "single",
- "daily_spend_limit": "string",
- "daily_spend_limit_enabled": false,
- "billing_group_id": "string"
}
Attaches the specified connections to an outbound profile if they are not already attached. Note that this endpoint never removes connections already attached.
Outbound Profile updated response
Bad request
Unauthorized
{- "connection_ids": [
- "string"
]
}
{- "id": "string",
- "user_id": "string",
- "connections": [
- { }
], - "name": null,
- "traffic_type": 1,
- "service_plan": 4,
- "cps_limit": 100,
- "ports": 0,
- "translation_rule": "string",
- "active": true,
- "cps_limit_increase": 0,
- "tag_list": [
- "string"
], - "usage_payment_method": "rate-deck",
- "custom_rate_deck": false,
- "rate_deck_url": "string",
- "whitelisted_destination_format": "alpha2",
- "whitelisted_destinations": [
- "US",
- "BR",
- "AU"
], - "max_destination_rate": 0,
- "connection_id": "string",
- "call_recording_type": "all",
- "call_recording_phone_numbers": [
- "string"
], - "call_recording_format": "wav",
- "call_recording_channels": "single",
- "daily_spend_limit": "string",
- "daily_spend_limit_enabled": false,
- "billing_group_id": "string"
}