ALalianza
Calling Plan

Add Calling Plan for a given reference

will add a callingplan

put/v2/partition/{partitionId}/account/{accountId}/callingplan

Request

Path parameters

accountIdstring required

ID of account

partitionIdstring required

ID of partition

Request body

referenceType'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER'
referenceIdstring
callingPlanProductIdstring

Deprecated. Use the callingPlanReferenceId

callingPlanReferenceIdstring

When modifying an existing calling plan list, this is the calling plan product id. When opting to share an existing calling plan list, this is the the reference id that has the calling plan list that the new reference would share.

callingPlanType'SHARED_CALLING_PLAN' | 'NEW_CALLING_PLAN' | 'UNSHARED_CALLING_PLAN'

Indicates if the request is for a change to an existing calling plan list, share a calling plan list with another reference, or stop sharing the configured list with other references.

pendingboolean

If false then the calling plan change will apply immediately. If true then the change will take place at the account billing date. Does not apply when the request is to share a calling plan.

minutesUsedinteger

Only used on add. Will only be applied to new plans. Will not be applied to pending plans plans. Does not apply when the request is to share a calling plan.

Response

Successful operation

idstring
referenceIdstring
referenceType'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER'
callingPlanProductIdstring
endDatestring date-time
startDatestring date-time
planMinutesinteger
secondsRemaininginteger

Changes

No recorded changes to this operation across all 1 revision of this API.