PracticeMessagingDto - SodiumHQ API Schema

Properties

Name	Type	Description
status	enum	Unavailable Off SettingUp AwaitingNumber Active
Unavailable Off SettingUp AwaitingNumber Active
isServiceAvailable	boolean	False when messaging is unavailable, or when the Messaging Service could not be reached for the senders (which are then null). The rest is still the practice's own state.
False when messaging is unavailable, or when the Messaging Service could not be reached for the senders (which are then null). The rest is still the practice's own state.
enabledDate	string	When messaging was switched on; null while it is off
When messaging was switched on; null while it is off
enabledByUserName	string	Who switched messaging on; null while it is off
Who switched messaging on; null while it is off
senders	array of PracticeMessagingSenderDto	The numbers the practice sends from, one per channel at most. Null when not read: before the practice's messaging account is set up, or while the service is unreachable.
The numbers the practice sends from, one per channel at most. Null when not read: before the practice's messaging account is set up, or while the service is unreachable.
numberApplication	PracticeMessagingNumberApplicationDto
whatsApp	PracticeMessagingWhatsAppDto
hasConversations	boolean	The practice has message conversations. They are kept when its number is cancelled, so their history stays visible with no number.
The practice has message conversations. They are kept when its number is cancelled, so their history stays visible with no number.
hasPayableMandate	boolean	The practice has a Direct Debit that can collect (active, or new and not yet collected on). Applying for a number, buying credits and switching on automatic top-up need one: without it they are a 409 billing_mandate_required. Null when not known: messaging is unavailable, Account Hub could not be reached, or this is the answer of a change rather than the read.
The practice has a Direct Debit that can collect (active, or new and not yet collected on). Applying for a number, buying credits and switching on automatic top-up need one: without it they are a 409 billing_mandate_required. Null when not known: messaging is unavailable, Account Hub could not be reached, or this is the answer of a change rather than the read.
twilioAccountSid	string	The practice's Twilio subaccount SID (AC...). Only the superadmin read sets it; null on the practice's own routes, before the practice is set up, or while the service is unreachable.
The practice's Twilio subaccount SID (AC...). Only the superadmin read sets it; null on the practice's own routes, before the practice is set up, or while the service is unreachable.

JSON Example

{
  "status": "Unavailable",
  "isServiceAvailable": false,
  "enabledDate": "2024-01-01T00:00:00Z",
  "enabledByUserName": "string",
  "senders": [
    {
      "channel": "...",
      "address": "...",
      "isOwnedNumber": "...",
      "isSandbox": "..."
    }
  ]
}

Used By Operations

Contained in Schemas

PracticeWhatsAppDisconnectedDto The practice's WhatsApp disconnected