com.gigs.virtualNumber.canceled

Name
object
Type
string
Description
Type of object is always event.
Allowed values: event
Name
id
Type
string
Description
Unique identifier for the event.
Example: "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
Name
actor
Type
Actor
Description
Example: {"type":"user","user":"usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"},{"type":"apiKey","apiKey":"apk_0SNlurA049MEWV4wRq2ql6SYZxiY"},{"type":"member","member":"mbr_0SNlurA020zhzt0CwsIr53"},{"type":"system"}
Name
data
Type
VirtualNumber
Status
PREVIEW
Description
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
datacontenttype
Type
string
Description
The RFC 2046 content-type.
Example: "application/json"
Default: application/json
Name
project
Type
string
Description
Unique identifier for the project where the event occurred.
Example: "gigs"
Name
source
Type
string
Description
URI identifying the event source.
Example: "https://api.gigs.com"
Default: https://api.gigs.com
Name
specversion
Type
string
Description
The CloudEvents spec version.
Example: "1.0"
Default: 1.0
Name
time
Type
string
Description
Time when the event occurred.
Example: "2022-03-16T14:12:42Z"
Name
type
Type
string
Description
Type is always com.gigs.virtualNumber.canceled.
Allowed values: com.gigs.virtualNumber.canceled
Name
version
Type
string
Description
API version used to serialize the data and the event itself.
Default: 2025-05-22

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "actor": {
    "type": "user",
    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
  },
  "data": {
    "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"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42.0Z",
  "type": "com.gigs.virtualNumber.canceled",
  "version": "2025-05-22"
}