VirtualNumber

Preview

This schema is currently in preview and might change in the future.

We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.

Virtual numbers are additional numbers that can be added for a user. Any calls made or texts sent to an active virtual number will be received by the primary number of the subscription. Note that this is an experimental feature that is only available in select projects.

  • Name
    object
    Type
    string
    Description

    Type of object is always virtualNumber.

    Allowed values: virtualNumber 
  • Name
    id
    Type
    string
    Description

    Unique identifier for the virtual number.

    Example: "vnr_0SNlurA049MEWV29mxRtSMDnKtUD"
  • Name
    activatedAt
    Type
    nullable string
    Description

    Time when the virtual number was activated.

    Example: "2020-01-01T00:00:07Z"
  • Name
    canceledAt
    Type
    nullable string
    Description

    Time when the virtual number was canceled.

    Example: "2020-07-15T00:00:00Z"
  • Name
    createdAt
    Type
    string
    Description

    Time when the virtual number was created.

    Example: "2020-01-01T00:00:00Z"
  • Name
    endedAt
    Type
    nullable string
    Description

    Time when the virtual number will end or has ended. This field is populated in different scenarios:

    • When a virtual number is canceled, this represents the future date when it will be terminated
    • When a virtual number has already ended, this represents the past date when it was terminated
    Example: "2020-08-01T00:00:00Z"
  • Name
    phoneNumber
    Type
    nullable string
    Description

    The virtual phone number.

    Example: "+447700900000"
  • Name
    status
    Type
    string
    Description

    The current status of the virtual number.

    Example: "active"
    Allowed values: active ended initiated processing 
  • Name
    subscription
    Type
    string
    Description

    Unique identifier for the subscription this virtual number belongs to.

    Example: "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
  • Name
    user
    Type
    string
    Description

    Unique identifier for the user this virtual number belongs to.

    Example: "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"

Example

{
  "object": "virtualNumber",
  "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
  "activatedAt": "2020-01-01T00:00:07Z",
  "canceledAt": "2020-07-15T00:00:00Z",
  "createdAt": "2020-01-01T01:01:01.0Z",
  "endedAt": "2020-08-01T00:00:00Z",
  "phoneNumber": "+447700900000",
  "status": "active",
  "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
  "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
}