Skip to content
ReputeCastReputeCast Docs

SMS providers: health, spend, senders and routes

GET
/api/v1/workspaces/{workspace}/sms/overview
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sms/overview \
  --header 'Authorization: Bearer <token>'

Permission: providers:view

Credentials are never returned.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
canManage
required
boolean
checkedAt
string format: date-time
helpers
required
Array<string>
notConnected
required
Array<object>
object
adapter
required
string
badges
required
Array<object>
object
capability
required
string
Allowed values: toll_free 10dlc sender_ids receipts inbound opt_out_sync registration pricing
note
string
support
required
string
Allowed values: yes partial no
connected
required
integer format: int64
fields
required
Array<object>
object
default
string
help
string
key
required
string
label
required
string
options
Array<string>
required
required
boolean
secret
required
boolean
name
required
string
summary
required
string
version
required
string
webhooks
required
string
Allowed values: registered manual
other
required
string
Allowed values: dont_send route
otherSender
string
providers
required
Array<object>
object
accountHint
required
string
accountLabel
required
string
adapter
required
string
answer
string
badges
required
Array<object>
object
capability
required
string
Allowed values: toll_free 10dlc sender_ids receipts inbound opt_out_sync registration pricing
note
string
support
required
string
Allowed values: yes partial no
connectedAt
required
string format: date-time
connectedBy
required
string
console
required
string
countries
required
Array<string>
demo
required
boolean
detail
string
failedPct
required
number format: double
filteredPct
required
number format: double
held
required
Array<string>
heldTexts
required
integer format: int64
id
required
string
lastCheckedAt
string format: date-time
lastReceiptAt
string format: date-time
live
required
boolean
name
required
string
optOutSync
required
string
Allowed values: two_way read_only off
pauseFailed
required
number format: double
pauseFiltered
required
number format: double
priceCountries
required
Array<string>
priceMax
required
number format: double
priceMin
required
number format: double
receiptsSince
required
integer format: int64
secretLabels
required
Array<string>
senderCount
required
integer format: int64
senderIdCountries
required
integer format: int64
senderIds
required
Array<string>
senderKinds
required
Array<string>
sentSince
required
integer format: int64
since
string format: date-time
spend
required
number format: double
status
required
string
Allowed values: healthy degraded down credentials_rejected
testMode
required
boolean
told
required
Array<string>
webhookUrl
required
string
webhooks
required
string
Allowed values: registered manual
routes
required
Array<object>
object
countries
required
Array<string>
fallback
required
string
fallbackProvider
required
string
id
required
string
provider
required
string
registration
required
string
sender
required
string
skipped
required
boolean
senders
required
Array<object>
object
adapter
required
string
brand
object
country
required
string
kind
required
string
Allowed values: toll_free brand campaign sender_id ""
name
string
readAt
string format: date-time
reason
string
setBy
string
since
string format: date-time
source
required
string
Allowed values: api manual rule ""
status
required
string
Allowed values: not_registered pending verified approved rejected allowed not_supported
campaign
object
country
required
string
kind
required
string
Allowed values: toll_free brand campaign sender_id ""
name
string
readAt
string format: date-time
reason
string
setBy
string
since
string format: date-time
source
required
string
Allowed values: api manual rule ""
status
required
string
Allowed values: not_registered pending verified approved rejected allowed not_supported
canSend
required
boolean
countries
required
Array<string>
held
required
boolean
id
required
string
kind
required
string
Allowed values: toll_free 10dlc local mobile sender_id
label
required
string
manual
required
boolean
provider
required
string
providerId
required
string
registration
required
object
country
required
string
kind
required
string
Allowed values: toll_free brand campaign sender_id ""
name
string
readAt
string format: date-time
reason
string
setBy
string
since
string format: date-time
source
required
string
Allowed values: api manual rule ""
status
required
string
Allowed values: not_registered pending verified approved rejected allowed not_supported
routes
required
Array<Array<string>>
throughput
required
number format: double
value
required
string
tiles
required
object
alertPct
required
integer format: int64
budget
required
number format: double
budgetHeld
required
integer format: int64
byKind
required
object
key
additional properties
integer format: int64
delivered
required
integer format: int64
deliveredPct
required
number format: double
failed
required
integer format: int64
month
required
string format: date-time
sent
required
integer format: int64
spend
required
number format: double
spendBy
required
Array<object>
object
name
required
string
spend
required
number format: double
suppressed
required
integer format: int64
suppressedBy
required
object
key
additional properties
integer format: int64
timezone
required
string

Example 

{
  "notConnected": [
    {
      "badges": [
        {
          "capability": "toll_free",
          "support": "yes"
        }
      ],
      "webhooks": "registered"
    }
  ],
  "other": "dont_send",
  "providers": [
    {
      "badges": [
        {
          "capability": "toll_free",
          "support": "yes"
        }
      ],
      "optOutSync": "two_way",
      "status": "healthy",
      "webhooks": "registered"
    }
  ],
  "senders": [
    {
      "brand": {
        "kind": "toll_free",
        "source": "api",
        "status": "not_registered"
      },
      "campaign": {
        "kind": "toll_free",
        "source": "api",
        "status": "not_registered"
      },
      "kind": "toll_free",
      "registration": {
        "kind": "toll_free",
        "source": "api",
        "status": "not_registered"
      }
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0