Browse Assigned DIDs

Action Name: DidBrowseAction

Purpose: Using an Account ID or Trunk Group ID (UserId), filter the DIDs on the system based one of those parameters. If multiple parameters are specified, then the priority is Account ID then OrganizationId and lastly UserId. If no parameters are specified then it obtains all the DIDs on the system.

Parameters

Parameter Name	Description	Validations	Required
AccountId	Trunking.io account ID	Account ID must match an Account on the system	✕
UserId	Trunk Group ID	UserID must match an existing Trunk Group ID	✕

Responses

Valid response

HTTP Code: 200

Invalid response

HTTP Code: 200

Read Assigned DIDs

Action Name: DidReadAction

Purpose: Given a valid PhoneNumber or a DID Id tries to obtain the DID data from the system. If both parameters are specified then the priority is the Number and then the DID Id

Authorization

Based on the owner of the DID

Parameters

Parameter Name	Description	Validations	Required
Number	A valid NA Phone Number	Valid Phone Number that corresponds to a DID on the system	✕
DidId	Trunking.io DID ID	Did Id must match a DID on the system	✕

Neither is required but one must be specified.

Responses

Valid response

HTTP Code: 200

Invalid response

HTTP Code: 200

Not Authorized response

HTTP Code: 200

Edit Assigned DID Caller ID

Action Name: DidEditNameAction

Purpose: Given a valid DID Id updates its Caller ID

Authorization

Based on the owner of the DID

Parameters

Parameter Name	Description	Validations	Required
DidId	Trunking.io DID ID	Did Id must match a DID on the system	✓
Name	The Caller ID that will be assigned to the DID	A String between 1 and 52 characters	✓

Responses

Valid response

HTTP Code: 200

Invalid response

HTTP Code: 200

Not Authorized response

HTTP Code: 200

Edit Assigned DID Note

Action Name: DidEditNameAction

Purpose: Given a valid DID Id updates its Note

Authorization

Based on the owner of the DID

Parameters

Parameter Name	Description	Validations	Required
DidId	Trunking.io DID ID	DID ID must match a DID on the system	✓
Note	The Tag that will be assigned to the DID. Used for organizing DIDs in the User Portal	A String between 1 and 100 characters	✓

Responses

Valid response

HTTP Code: 200

Not Authorized response

HTTP Code: 200

Enable/Disable CNAM Dip for Assigned DID

Action Name: DidEditCnamDipAction

Purpose: Given a valid DID ID enables or disables CNAM Dip

Authorization

Based on the owner of the DID

Parameters

Parameter Name	Description	Validations	Required
DidId	Trunking.io DID ID	DID ID must match a DID on the system	✓
CnamDipEnable	Boolean value that indicates if CNAM Dip should be enabled or not	Boolean value, true or false	✓

Responses

Valid response

HTTP Code: 200

Invalid response

HTTP Code: 200

Not Authorized response

HTTP Code: 200

 

Remove Assigned DID

Action Name: DidDeleteAction

Purpose: Given a valid DID Id it releases the DID to the pool of available DIDs

Authorization

Based on the owner of the DID. User’s role should be Account Admin or higher

Parameters

Parameter Name	Description	Validations	Required
DidId	Trunking.io DID ID	Did Id must match a DID on the system (DID must be assigned to an user)	✓

Responses

Valid response

HTTP Code: 200

Invalid response

HTTP Code: 200

Not Authorized response

HTTP Code: 200

Release Assigned DIDs

Action Name: DidReleaseAction

Purpose: Given a array of valid DID ids, this will remove DIDs from your Trunking.io account.

Parameters

Parameter Name	Description	Validations	Required
DidIds[x] Note , replace the x with a value from 0 to n (where n is a positive integer) Can specify multiple	Trunking.io DID ID	Did Id must match a DID on the system (DID must be assigned to an user)	✓

Responses

Valid response

HTTP Code: 200

Invalid response

HTTP Code: 200

Not Authorized response

HTTP Code: 200

Reserve Assigned DIDs

Action Name: DidReserveAction

Purpose: Given a array of valid DID ids, change released the DID to the pool with the status to reserved

Parameters

Parameter Name	Description	Validations	Required
DidIds[x] Note , replace the x with a value from 0 to n (where n is a positive integer) Can specify multiple	Trunking.io DID ID	Did Id must match a DID on the system (DID must be assigned to an user)	✓

Responses

Valid response

HTTP Code: 200

Invalid response

HTTP Code: 200

Not Authorized response

HTTP Code: 200