- Name
object
- Type
- string
- Description
Type of object is always
event
.
required- Name
id
- Type
- string
- Description
Unique identifier for the event.
Example:evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
required- Name
data
- Type
- object
- Description
- Name
object
- Type
- string
- Description
Type of object is always
porting
.
required- Name
id
- Type
- string
- Description
Unique identifier for the porting.
Example:prt_0SNlurA049MEWV39s2kSYqaat7ZS
required- Name
accountNumber
- Type
- nullable string
- Description
The account number on the donor service provider.
Example:123456789
required- Name
accountPinExists
- Type
- boolean
- Description
Whether the account PIN has been provided.
Example:true
required- Name
address
- Type
- nullable object
- Description
- The address of the account holder on the donor service provider.
required- Name
birthday
- Type
- nullable string
- Description
The birthday of the account holder on the donor service provider.
Example:2017-07-21
required- Name
declinedAttempts
- Type
- integer
- Description
The number of declined porting attempts so far.
Example:0
>= 0
required- Name
declinedCode
- Type
- nullable string PREVIEW
- Description
The code reason for the declined porting.
Example:portingPhoneNumberPortProtected
required- Name
declinedMessage
- Type
- nullable string PREVIEW
- Description
The reason description for the declined porting.
Example:The phone number has port protection on the provider.
required- Name
donorProvider
- Type
- nullable object
- Description
- The service provider from whom the number is ported.
required- Name
donorProviderApproval
- Type
- nullable boolean
- Description
Whether the donor provider has approved or not the porting.
Example:true
required- Name
firstName
- Type
- nullable string
- Description
The first name of the account holder on the donor service provider.
Example:Jerry
required- Name
lastName
- Type
- nullable string
- Description
The last name of the account holder on the donor service provider.
Example:Seinfeld
required- Name
phoneNumber
- Type
- string
- Description
The phone number to port in E.164 format.
Example:+19591234567
required- Name
provider
- Type
- string
- Description
The ID of the recipient network provider.
Example:p9
required- Name
recipientProvider
- Type
- object
- Description
- The service provider to whom the number is ported.
required- Name
required
- Type
- array
- Description
List of fields required for the porting to be processable. The fields depend on the donor and recipient providers.
Example:accountNumber,accountPin,address,birthday,donorProvider,donorProviderApproval,firstName,lastName
required- Name
status
- Type
- string
- Description
The current status of the porting.
Allowed values:draft, pending, informationRequired, requested, declined, completed, canceled, expired
required- Name
subscription
- Type
- nullable string
- Description
Unique identifier for the porting subscription.
Example:sub_0SNlurA049MEWV2gSfSxi00xlPIi
required- Name
user
- Type
- string
- Description
Unique identifier for the user this porting is for.
Example:usr_0SNlurA049MEWV4OpCwsNyC9Kn2d
required- Name
canceledAt
- Type
- nullable string
- Description
Time when the porting was canceled.
Example:2021-01-21T19:39:53Z
required- Name
completedAt
- Type
- nullable string
- Description
Time when the porting was completed.
Example:2021-01-21T19:36:57Z
required- Name
createdAt
- Type
- string
- Description
Time when the porting was created.
Example:2021-01-21T19:12:28Z
required- Name
expiredAt
- Type
- nullable string
- Description
Time when the porting was expired.
Example:2021-01-21T19:39:53Z
required- Name
lastDeclinedAt
- Type
- nullable string
- Description
Time when the porting was last declined.
Example:2021-01-21T19:31:13Z
required- Name
lastRequestedAt
- Type
- nullable string
- Description
Time when the porting was last requested.
Example:2021-01-21T19:22:31Z
required
required- Name
datacontenttype
- Type
- string
- Description
The RFC 2046 content-type.
Example:application/json
Default:application/json
required- Name
project
- Type
- string
- Description
Unique identifier for the project where the event occurred.
Example:gigs
required- Name
source
- Type
- string
- Description
URI identifying the event source.
Example:https://api.gigs.com
Default:https://api.gigs.com
required- Name
specversion
- Type
- string
- Description
The CloudEvents spec version.
Example:1.0
Default:1.0
required- Name
time
- Type
- string
- Description
Time when the event occurred.
Example:2022-03-16T14:12:42Z
required- Name
type
- Type
- string
- Description
Type is always
com.gigs.porting.deleted
.
required- Name
version
- Type
- string
- Description
API version used to serialize the data and the event itself.
Default:2024-08-29
required
Example
{
"object": "event",
"id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
"data": {
"object": "porting",
"id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
"accountNumber": "123456789",
"accountPinExists": true,
"address": {
"city": "New York City",
"country": "US",
"line1": "129 West 81st Street",
"line2": "Apartment 5A",
"postalCode": "10024",
"state": "NY"
},
"birthday": "2017-07-21",
"declinedCode": "portingPhoneNumberPortProtected",
"declinedMessage": "The phone number has port protection on the provider.",
"donorProvider": {
"object": "serviceProvider",
"id": "svp_0SNlurA01K6GY5L0XJffY8",
"name": "AT&T",
"recipientProviders": [
"p3"
]
},
"donorProviderApproval": true,
"firstName": "Jerry",
"lastName": "Seinfeld",
"phoneNumber": "+19591234567",
"provider": "p9",
"recipientProvider": {
"object": "serviceProvider",
"id": "svp_0SNlurA01K6GY5L0XJffY8",
"name": "AT&T",
"recipientProviders": [
"p3"
]
},
"required": [
"accountNumber",
"accountPin",
"address",
"birthday",
"donorProvider",
"donorProviderApproval",
"firstName",
"lastName"
],
"status": "draft",
"subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
"user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
"canceledAt": "2021-01-21T19:39:53Z",
"completedAt": "2021-01-21T19:36:57Z",
"createdAt": "2021-01-21T19:12:28Z",
"expiredAt": "2021-01-21T19:39:53Z",
"lastDeclinedAt": "2021-01-21T19:31:13Z",
"lastRequestedAt": "2021-01-21T19:22:31Z"
},
"datacontenttype": "application/json",
"project": "gigs",
"source": "https://api.gigs.com",
"specversion": "1.0",
"time": "2022-03-16T14:12:42Z",
"type": "com.gigs.porting.deleted",
"version": "2024-08-29"
}