AT&T Business Voice & Cloud Voice APIs

Version 0.0.1 (latest)

Create a Agreement

Version 0.0.1

Retrieve an existing agreement by sending a request including a Billing Account Number (BAN) or Foundation Account Number (FAN) and Service Provider AccountId.

POST
https://serverRoot/tmf-api/agreementManagement/agreement/create
Download API Specification
arrowRequest

Header Parameters

          Body Parameters

          Responses

          Created

          arrowBody

          application/json

          Example Request

          1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
          curl --request POST \
     --url https://serverroot/tmf-api/agreementManagement/agreement/create \
     --header 'Authorization: string' \
     --header 'X-ATT-ClientId: string' \
     --header 'X-ATT-ConversationId: string' \
     --header 'X-ATT-CorrelationId: string' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "name": "Business Voice & Cloud Voice Agreement",
  "summary": "Create a Agreement Example",
  "serviceType": "ACV-Mobile",
  "engagedParty": [
    {
      "id": "12345678910",
      "name": "BAN"
    },
    {
      "id": "ABCDEF",
      "name": "ServiceProviderAccountId"
    }
  ],
  "agreementType": "Commercial",
  "characteristic": {
    "name": "externalReferenceId",
    "value": "abcdefghij-1234-5678-abcd-abcdefg1234"
  }
}
'

          Example Response

          1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
          {
  "name": "Business Voice & Cloud Voice Agreement",
  "status": "inProgress",
  "serviceType": "ACV-Mobile",
  "engagedParty": [
    {
      "id": "12345678910",
      "name": "BAN"
    },
    {
      "id": "ABCDEF",
      "name": "ServiceProviderAccountId"
    }
  ],
  "agreementType": "Commercial",
  "characteristic": {
    "name": "externalRefernceId",
    "value": "abcdefghij-1234-5678-abcd-abcdefg1234"
  }
}