Skip to content
Notavia Notavia Docs

Get SMS provider settings for an environment

GET
/v1/environments/{envId}/sms-settings
 
curl --request GET \
  --url https://your-notavia-host/v1/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sms-settings \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
envId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

SMS settings.

Media type application/json
object
id
string format: uuid
kind
string
Allowed values: Managed Twilio Vonage
from_number
string
nullable
from_sender_id
string
nullable
credentials_validated
boolean
credentials_validated_at
string format: date-time
nullable
Example 
{
  "kind": "Managed"
}

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Section titled “403 ”

Credentials do not have the required scope.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

404

Section titled “404 ”

Resource not found.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}