Voice applications

List the project's voice applications

GET

https://api.signals.pressone.africa/v1

/voice/applications

List the project's voice applications › Headers

X-Project-ID

string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

List the project's voice applications › Responses

Every active voice application, ordered by name.

VoiceApplicationList

VoiceApplication[] · required

GET/voice/applications

curl https://api.signals.pressone.africa/v1/voice/applications \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "created_at": "2024-08-25T15:00:00Z",
      "desired_revision": 0,
      "effective_revision": 0,
      "fallback_method": "GET",
      "fallback_url": "https://www.example.com/path/to/resource",
      "id": "id",
      "name": "name",
      "numbers_pointed": 0,
      "project_id": "project_id",
      "provisioning_status": "pending",
      "revision": 0,
      "status_callback_method": "GET",
      "status_callback_url": "https://www.example.com/path/to/resource",
      "updated_at": "2024-08-25T15:00:00Z",
      "voice_method": "GET",
      "voice_url": "https://www.example.com/path/to/resource"
    }
  ]
}

json

application/json

Create a voice application

POST

https://api.signals.pressone.africa/v1

/voice/applications

Create a voice application › Headers

Idempotency-Key

string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

X-Project-ID

string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Create a voice application › Request Body

CreateVoiceApplicationRequest

name

string · required

voice_method

VoiceHttpMethod · enum · required

Enum values:

GET

POST

voice_url

string · uri · required

fallback_url

string | null · uri

status_callback_url

string | null · uri

Create a voice application › Responses

An idempotent replay of an earlier create.

VoiceApplication

created_at

string · date-time · required

desired_revision

integer · int64 · required

effective_revision

integer · int64 · required

required

fallback_url

string | null · uri · required

id

string · required

name

string · required

numbers_pointed

integer · int64 · required

project_id

string · required

provisioning_status

VoiceProvisioningStatus · enum · required

Enum values:

pending

applying

applied

partially_applied

failed

revision

integer · int64 · required

required

status_callback_url

string | null · uri · required

updated_at

string · date-time · required

voice_method

VoiceHttpMethod · enum · required

Enum values:

GET

POST

voice_url

string · uri · required

POST/voice/applications

curl https://api.signals.pressone.africa/v1/voice/applications \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "fallback_method": "GET",
  "fallback_url": "https://www.example.com/path/to/resource",
  "name": "name",
  "status_callback_method": "GET",
  "status_callback_url": "https://www.example.com/path/to/resource",
  "voice_method": "GET",
  "voice_url": "https://www.example.com/path/to/resource"
}'

Example Request Body

{
  "fallback_method": "GET",
  "fallback_url": "https://www.example.com/path/to/resource",
  "name": "name",
  "status_callback_method": "GET",
  "status_callback_url": "https://www.example.com/path/to/resource",
  "voice_method": "GET",
  "voice_url": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "created_at": "2024-08-25T15:00:00Z",
  "desired_revision": 0,
  "effective_revision": 0,
  "fallback_method": "GET",
  "fallback_url": "https://www.example.com/path/to/resource",
  "id": "id",
  "name": "name",
  "numbers_pointed": 0,
  "project_id": "project_id",
  "provisioning_status": "pending",
  "revision": 0,
  "status_callback_method": "GET",
  "status_callback_url": "https://www.example.com/path/to/resource",
  "updated_at": "2024-08-25T15:00:00Z",
  "voice_method": "GET",
  "voice_url": "https://www.example.com/path/to/resource"
}

json

application/json

Read a voice application

GET

https://api.signals.pressone.africa/v1

/voice/applications/{application_id}

Read a voice application › path Parameters

application_id

string · required

Voice application id

Read a voice application › Headers

X-Project-ID

string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Read a voice application › Responses

The voice application.

VoiceApplication

created_at

string · date-time · required

desired_revision

integer · int64 · required

effective_revision

integer · int64 · required

required

fallback_url

string | null · uri · required

id

string · required

name

string · required

numbers_pointed

integer · int64 · required

project_id

string · required

provisioning_status

VoiceProvisioningStatus · enum · required

Enum values:

pending

applying

applied

partially_applied

failed

revision

integer · int64 · required

required

status_callback_url

string | null · uri · required

updated_at

string · date-time · required

voice_method

VoiceHttpMethod · enum · required

Enum values:

GET

POST

voice_url

string · uri · required

GET/voice/applications/{application_id}

curl https://api.signals.pressone.africa/v1/voice/applications/:application_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "created_at": "2024-08-25T15:00:00Z",
  "desired_revision": 0,
  "effective_revision": 0,
  "fallback_method": "GET",
  "fallback_url": "https://www.example.com/path/to/resource",
  "id": "id",
  "name": "name",
  "numbers_pointed": 0,
  "project_id": "project_id",
  "provisioning_status": "pending",
  "revision": 0,
  "status_callback_method": "GET",
  "status_callback_url": "https://www.example.com/path/to/resource",
  "updated_at": "2024-08-25T15:00:00Z",
  "voice_method": "GET",
  "voice_url": "https://www.example.com/path/to/resource"
}

json

application/json

Delete a voice application

DELETE

https://api.signals.pressone.africa/v1

/voice/applications/{application_id}

Delete a voice application › path Parameters

application_id

string · required

Voice application id

Delete a voice application › Headers

If-Match

string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID

string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Delete a voice application › Responses

The voice application was deleted.

No data returned

Update a voice application

PATCH

https://api.signals.pressone.africa/v1

/voice/applications/{application_id}

Update a voice application › path Parameters

application_id

string · required

Voice application id

Update a voice application › Headers

If-Match

string · required

The quoted revision the caller last read, so a concurrent change answers 412.

X-Project-ID

string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Update a voice application › Request Body

UpdateVoiceApplicationRequest

fallback_url

string | null · uri

name

string | null

status_callback_url

string | null · uri

voice_url

string | null · uri

Update a voice application › Responses

The voice application after the update.

VoiceApplication

created_at

string · date-time · required

desired_revision

integer · int64 · required

effective_revision

integer · int64 · required

required

fallback_url

string | null · uri · required

id

string · required

name

string · required

numbers_pointed

integer · int64 · required

project_id

string · required

provisioning_status

VoiceProvisioningStatus · enum · required

Enum values:

pending

applying

applied

partially_applied

failed

revision

integer · int64 · required

required

status_callback_url

string | null · uri · required

updated_at

string · date-time · required

voice_method

VoiceHttpMethod · enum · required

Enum values:

GET

POST

voice_url

string · uri · required

PATCH/voice/applications/{application_id}

curl https://api.signals.pressone.africa/v1/voice/applications/:application_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'If-Match: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "fallback_method": "GET",
  "fallback_url": "https://www.example.com/path/to/resource",
  "name": "name",
  "status_callback_method": "GET",
  "status_callback_url": "https://www.example.com/path/to/resource",
  "voice_method": "GET",
  "voice_url": "https://www.example.com/path/to/resource"
}'

Example Request Body

{
  "fallback_method": "GET",
  "fallback_url": "https://www.example.com/path/to/resource",
  "name": "name",
  "status_callback_method": "GET",
  "status_callback_url": "https://www.example.com/path/to/resource",
  "voice_method": "GET",
  "voice_url": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "created_at": "2024-08-25T15:00:00Z",
  "desired_revision": 0,
  "effective_revision": 0,
  "fallback_method": "GET",
  "fallback_url": "https://www.example.com/path/to/resource",
  "id": "id",
  "name": "name",
  "numbers_pointed": 0,
  "project_id": "project_id",
  "provisioning_status": "pending",
  "revision": 0,
  "status_callback_method": "GET",
  "status_callback_url": "https://www.example.com/path/to/resource",
  "updated_at": "2024-08-25T15:00:00Z",
  "voice_method": "GET",
  "voice_url": "https://www.example.com/path/to/resource"
}

json

application/json

List the number route slices that target a voice application

GET

https://api.signals.pressone.africa/v1

/voice/applications/{application_id}/numbers

List the number route slices that target a voice application › path Parameters

application_id

string · required

Voice application id

List the number route slices that target a voice application › Headers

X-Project-ID

string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

List the number route slices that target a voice application › Responses

Every route slice that targets the application.

NumberRouteList

NumberRouteSlice[] · required

Voice account