FAQ for Organization
  • Welcome
  • Onboarding Guide
    • Mandatory settings
      • 1. Integrate your Telecoms
      • 2. Create Company
      • 3. Upload your SIM(s)
      • 4. Create Plan(s)
      • 5. Assign the plan to SIM(s)
    • Optional settings
      • 1. Account Settings
      • 2. User Profile
      • 3. PSP Integration
      • 4. Invoice Integration
      • 5. Create Pools
      • 6. Invite Staff
      • 7. Customize Columns
      • 8. Notifications
      • 9. Communication
  • Menu
    • Roles on the platform
    • SIMs
      • SIM Statuses
      • General Terms
      • Key Features
      • Q&A
    • Satellite
      • Terminal Statuses
      • Upload Terminals
    • Pools
    • Plans
      • Prepaid
      • Subscription
      • PAYGO
    • Companies
    • End Users
    • Automation - Rules
    • Transactions
    • Wallet
    • Webhooks
      • Terms used
      • Endpoint validation
      • Authentication
      • Webhook Payload Models
        • Account Model
        • End User Model
        • Account Address Model
        • Wallet Model
        • Plan Model
        • Pool Model
        • SIM Card Model
        • Status Model
        • User Model
        • Prepaid Refill Model
        • Date Time Model
        • Rule Model
        • Payment Model
        • Credit Card Model
      • Webhook Payload Types
        • Technical Payloads
        • Event Payloads
          • Company Events
          • Company Staff Events
          • End User Events
          • SIM Card Events
          • Payment Payloads
        • Rule Payloads
          • SIM Card Rule Payloads
          • SIM Pools Payloads
          • Wallet Payloads
  • e-SIM Store
    • Upload SIMs
    • eSIM Purchase & Activation
    • eSIM Store Activation
    • Q&A
Powered by GitBook
On this page
  1. Menu
  2. Webhooks
  3. Webhook Payload Models

Status Model

The Status Model – is a model for show platform status parameters. Model fields are presented in the table (Table 4.11), with an example below (Listing 4.8). There are the following types of this model (Table 4.12).

Table 4.11 – Fields of Status Model

№
Key
Type
Exists
Description

1

id

id, integer

required

Status identifier

2

title

string

required

Status title

Listing 4.8 – Example of Status Model (JSON)

{
    "id":      "1",
    "title":   "pending",
}

Table 4.12 – Status Types

№
Title
Description

1

Pending

Waiting for activation

2

Invalid

Broken

3

Active

In use

4

Suspended

I pause for some reason. Waiting for reactivation.

5

Not Available

Some problems with SIM

6

Blank

Need to assign one of the Plans

7

Activation

Ready Active, wait for first usage

8

Archived

Deleted or SIM Swaped

PreviousSIM Card ModelNextUser Model

Last updated 8 months ago