AT&T Business Voice & Cloud Voice APIs

The Agreement Management API facilitates partners in verifying existing service authorizations and establishing new ones when needed. By submitting either the Billing Account Number (BAN) or Foundation Account Number (FAN) along with the Service Provider AccountId, partners can efficiently manage authorizations.

The Create Agreement method is a synchronous POST operation. Upon initiation, the client sends a request as per the JSON guidelines, receiving an immediate acknowledgement. Post acknowledgement, the API asynchronously processes the request, publishing the message to a Kafka topic. Once a successful consumption response from Kafka is received, the corresponding consent is saved to the database. In case of any exceptions, an error message is returned. This operation provides a lightweight, TMF-compliant, RESTful interface, ensuring efficient and reliable agreement creation.

The Retrieve Agreement function is a synchronous GET operation. In this process, the client initiates a request, structured as per the request JSON guidelines. Upon receipt of this request, an immediate response is generated as per the response JSON format. This operation allows the client to efficiently retrieve existing agreement information, offering a streamlined and responsive interaction.

Usecases:

UCaaS Provider Use Case:

A Unified Communications as a Service (UCaaS) provider needs to verify if a customer has an existing authorization for certain cloud-based communication services. Using the AgreementManagement API, the provider can check this by sending the customer's Billing Account Number (BAN) or Foundation Account Number (FAN) along with the Service Provider AccountId. If there's no prior authorization, the provider can use the API to create a new one, enabling the customer to use their services without interruption.

VoIP Provider Use Case:

A Voice over Internet Protocol (VoIP) provider wants to launch a new feature for their existing customers. Before rolling out this feature, they need to check if the customers have the necessary authorizations in place. The provider can use the AgreementManagement API to verify this by sending the respective Billing Account Number (BAN) or Foundation Account Number (FAN) and Service Provider AccountId. If a customer doesn't have the required authorization, the provider can create a new one using the API, ensuring a smooth rollout of the new feature.