UnifiedAPI Reference

Welcome to the UnifiedAPI documentation. This API provides programmatic access to VoipNow telephony features.

Services

CDR Service

The CDR (Call-Detail Record) Service is used to return statistics about past phone calls.

This service is available to Apps registered to the following account types:

• Administrator

• Organization

• User

Faxes Service

The Fax Service is used to send faxes to any phone number, using a Phone Terminal Extension currently available in the system. The fax sent using this service does not need any approval. To use this service for an extension, you must first enable fax for it. For more details on sending and receiving faxes, check out the User's Fax Center section of the VoipNow User guide.

This service is available to Apps registered to the following account types:

• Administrator

• Organization

• User

PhoneCalls Service

The PhoneCall Service is used for real-time phone calls management. It allows making new phone calls, hanging up ongoing phone calls, transferring, recording, putting phone calls on hold, etc.

This service is available to Apps registered to the following account types:

• Administrator

• Organization

• User

PhoneCallEvents Service

The PhoneCallEvent Service is used to assign the following events to an Extension:

• Dial-In: occurs when a call is received by an extension.

• Dial-Out: occurs when a call is placed by an extension.

• Hangup: occurs when the extension hangs up.

• Answer on incoming call: occurs when an incoming phone call is answered.

• Answer on outgoing call (by the other party): occurs when an outgoing phone call is answered by the other party.

The Service is available to Apps registered to the following account types:

• Administrator

• Organization

• User

Presence Service

The Presence Service is used to fetch the registration status for Extensions.

This service is available to Apps registered to the following account types:

• Administrator

• Organization

• User

QueueAgents Service

The QueueAgents Service is used to log in, log out or pause an agent. You can find more details about the queues and how the system manages them in the Queue Extension section of the VoipNow manual.

This service is available to Apps registered to the following account types:

• Administrator

• Organization

• User

Reference

• Data Types - 10 data types documented
• HTTP Return Codes - Error codes and HTTP status responses