Provision API

Errors

-

content_copy
1
2
3
4
5
6
7
8
[
  {
    "code": "SomeErrorCode",
    "title": "TITLE_OF_THE_DOMAIN_ERROR",
    "ref": "https://developers.masstack.com/en/docs/apis_provision_doc_swagger/1/apioverview/#errors",
    "details": "Some error happened"
  }
]
Name Type Required Description
anonymous [Error] false none

Error

-

content_copy
1
2
3
4
5
6
{
  "code": "SomeErrorCode",
  "title": "TITLE_OF_THE_DOMAIN_ERROR",
  "ref": "https://developers.masstack.com/en/docs/apis_provision_doc_swagger/1/apioverview/#errors",
  "details": "Some error happened"
}
Name Type Required Description
code string false none
title string false none
ref string false none
details string false none

AmazonCancelSubscription

-

content_copy
1
2
3
4
{
  "external_id": "userid_8572394923",
  "reason": "CUSTOMER_OPT_OUT"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.
reason AmazonCancelReason true Indicates the reason for cancellation.
- BILLING_FAILED_RENEWAL: Customer did not meet financial obligations in time for the billing cycle.
- CUSTOMER_ACCOUNT_CHANGE: Customer has changed their account the offer is attached to.
- CUSTOMER_CLOSED_ACCOUNT: Customer closed their account with the mobile operator.
- CUSTOMER_INELIGIBLE: Customer was found to be ineligible for the offer.
- CUSTOMER_OPT_OUT: Customer cancelled the subscription.
- CUSTOMER_PLAN_CHANGE: Customer changed their rate plan and is no longer eligible for their subscription.
- MERCHANT_OPT_OUT: Cancellation originated by partner, which does not map to any of the other reasons.
- RESELLER_OPT_OUT: Cancellation originated by telco, which does not map to any of the other reasons.
- SUSPECTED_FRAUD: Suspected fraud.
- TEST_BUNDLE: Bundle was created for pre-launch testing, but has become stuck in an invalid state, or no longer desired, after launch.

AmazonCreateSubscription

-

content_copy
1
2
3
4
5
6
7
8
{
  "billing_id": "AAZ875147628",
  "email": "test@email.com",
  "external_id": "userid_8572394923",
  "msisdn": "+525512345678",
  "offer_code": "boku-web-demo",
  "product": "PV_3M_PROMO"
}
Name Type Required Description
billing_id AmazonBillingID true Unique subscriber identifier.
email AmazonEmail false The primary email address preferred by the customer.
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.
msisdn AmazonMSISDN false MSISDN
offer_code AmazonOfferCode true Offer identifier provided by Amazon.
product AmazonProductID true Amazon product identifier.

AmazonGenerateActivationUrl

-

content_copy
1
2
3
4
{
  "external_id": "userid_8572394923",
  "validity_duration_minutes": 30
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.
validity_duration_minutes AmazonActivationURLValidityDuration false Specifies the validity duration of the activation URL in minutes. If provided, the activation URL will be valid for the specified duration. If not provided, a default validity duration will be used. Value must be between 15 and 60 minutes.

AmazonGenerateAccountRecoveryUrl

-

content_copy
1
2
3
{
  "external_id": "userid_8572394923"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.

AmazonGenerateActivationURLResponse

-

content_copy
1
2
3
4
{
  "expiry_date": "2023-06-20T14:32:45+02:00",
  "url": "https://www.example.com/activation/123"
}
Name Type Required Description
expiry_date AmazonActivationURLExpiryDate false Date when activation URL expires in ISO 8601 format.
url AmazonActivationURL false Activation URL.

AmazonGetBundleDetailsResponse

-

content_copy
1
2
3
4
5
6
7
{
  "id": "9182ee-e139-4629-419909-024356f929c3",
  "state": "ACTIVATED",
  "product": "PV_3M_PROMO",
  "subscription_id": "1982io-e112-9002-123029-tr4006f919aa",
  "starts_at": "2016-08-22T09:25:54.394Z"
}
Name Type Required Description
id AmazonBundleID false Unique activated bundle id that is used in all subsequent operations.
state AmazonBundleState false State of the already active entitlement (bundle).
- ACTIVATED: Bundle was successfully validated and activated
- CANCELLED: Bundle was cancelled either by user or mobile operator
- FAILED: Bundle activation failed
- SUSPENDED: Bundle was suspended
product AmazonProductID false Amazon product identifier.
subscription_id AmazonSubscriptionID false Subscription identifier.
starts_at AmazonBundleStartsAt false ISO 8601 formatted bundle validity start.

AmazonResumeSubscription

-

content_copy
1
2
3
{
  "external_id": "userid_8572394923"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.

AmazonSuspendSubscription

-

content_copy
1
2
3
{
  "external_id": "userid_8572394923"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.

AmazonUpdateSubscription

-

content_copy
1
2
3
4
{
  "external_id": "userid_8572394923",
  "product": "PV_3M_PROMO"
}
Name Type Required Description
external_id AmazonExternalID true Identifier to associate an account in your system with an Amazon account.
product AmazonProductID true Amazon product identifier.

AmazonActivationURL

-

content_copy
1
"https://www.example.com/activation/123"
Name Type Required Description
anonymous string false Activation URL.

AmazonActivationURLValidityDuration

-

Name Type Required Description
anonymous integer(int32) false Specifies the validity duration of the activation URL in minutes. If provided, the activation URL will be valid for the specified duration. If not provided, a default validity duration will be used. Value must be between 15 and 60 minutes.

AmazonBillingID

-

content_copy
1
"AAZ875147628"
Name Type Required Description
anonymous string false Unique subscriber identifier.

AmazonBundleID

-

content_copy
1
"9182ee-e139-4629-419909-024356f929c3"
Name Type Required Description
anonymous string false Unique activated bundle id that is used in all subsequent operations.

AmazonBundleStartsAt

-

content_copy
1
"2016-08-22T09:25:54.394Z"
Name Type Required Description
anonymous string false ISO 8601 formatted bundle validity start.

AmazonBundleState

-

content_copy
1
"ACTIVATED"
Name Type Required Description
anonymous string false State of the already active entitlement (bundle).
- ACTIVATED: Bundle was successfully validated and activated
- CANCELLED: Bundle was cancelled either by user or mobile operator
- FAILED: Bundle activation failed
- SUSPENDED: Bundle was suspended

AmazonCancelReason

-

content_copy
1
"CUSTOMER_OPT_OUT"
Name Type Required Description
anonymous string false Indicates the reason for cancellation.
- BILLING_FAILED_RENEWAL: Customer did not meet financial obligations in time for the billing cycle.
- CUSTOMER_ACCOUNT_CHANGE: Customer has changed their account the offer is attached to.
- CUSTOMER_CLOSED_ACCOUNT: Customer closed their account with the mobile operator.
- CUSTOMER_INELIGIBLE: Customer was found to be ineligible for the offer.
- CUSTOMER_OPT_OUT: Customer cancelled the subscription.
- CUSTOMER_PLAN_CHANGE: Customer changed their rate plan and is no longer eligible for their subscription.
- MERCHANT_OPT_OUT: Cancellation originated by partner, which does not map to any of the other reasons.
- RESELLER_OPT_OUT: Cancellation originated by telco, which does not map to any of the other reasons.
- SUSPECTED_FRAUD: Suspected fraud.
- TEST_BUNDLE: Bundle was created for pre-launch testing, but has become stuck in an invalid state, or no longer desired, after launch.

AmazonEmail

-

content_copy
1
"test@email.com"
Name Type Required Description
anonymous string false The primary email address preferred by the customer.

AmazonActivationURLExpiryDate

-

content_copy
1
"2023-06-20T14:32:45+02:00"
Name Type Required Description
anonymous string false Date when activation URL expires in ISO 8601 format.

AmazonExternalID

-

content_copy
1
"userid_8572394923"
Name Type Required Description
anonymous string false Identifier to associate an account in your system with an Amazon account.

AmazonMSISDN

-

content_copy
1
"+525512345678"
Name Type Required Description
anonymous string false MSISDN

AmazonOfferCode

-

content_copy
1
"boku-web-demo"
Name Type Required Description
anonymous string false Offer identifier provided by Amazon.

AmazonProductID

-

content_copy
1
"PV_3M_PROMO"
Name Type Required Description
anonymous string false Amazon product identifier.

AmazonSubscriptionID

-

content_copy
1
"1982io-e112-9002-123029-tr4006f919aa"
Name Type Required Description
anonymous string false Subscription identifier.

NetflixCreateSubscription

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "billing_event_id": "e307f177-091a-4840-9830-dda1c29eea44",
  "bundle_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
  "channel": "WEB",
  "netflix_email": "test@email.com",
  "netflix_offer_id": "2106f808-36e9-402d-bf37-f1f7fa04776b",
  "netflix_phone": "+525512345678",
  "partner_account_id": 4567890123456789,
  "partner_charge_country": "ES",
  "preferred_language": "es-ES"
}
Name Type Required Description
billing_event_id NetflixBillingEventID true A reference for this transaction that can be used to track or reconcile this transaction, if needed in the future. Do not use a PAI value. Maximum size is 1024 bytes.
bundle_id NetflixBundleID true Describes your bundle offers. Each of your commercial bundle offers/plans should correspond to a unique BundleID. The BundleID is generated by Netflix. You are expected to pass it in the Update API when your customer changes from one bundle to another.
channel NetflixChannel true This attribute identifies the channel that the customer uses to sign up for the Bundle.
netflix_email NetflixEmail false The primary email address preferred by the customer. Value has to be in standard email format.
- Netflix will only update the email address for the bundle enrollment if the customer has not yet activated their bundle.
- Do not pass dummy email addresses for any customer. If you do not have the customer’s primary or preferred email address, do not pass any email address.
netflix_offer_id NetflixOfferID true A pre-agreed upon UUID for each of the Netflix plans (Basic, Standard, Premium, and other Netflix plans) available in your bundle offers. This is the actual offer for which the customer will be enrolled. It must not have a value less than the Base Plan value for the associated BundleId. Note: A NetflixOfferID corresponds to one (1) Netflix streaming plan (e.g., 1S - Basic, 2S - Standard, 4S - Premium). For each NetflixOfferID, Netflix generates a Sandbox (for testing) and Production version.
netflix_phone NetflixPhone false The mobile phone number preferred by the customer. Value must be in the E.164 format. +[CountryCode][PhoneNumber]
partner_account_id NetflixPartnerAccountId true Partner Account Identifier (PAI) to associate an account in your system with a Netflix account.
partner_charge_country NetflixPartnerChargeCountry true Two letter codes that conform to ISO 3166-1
preferred_language NetflixPreferredLanguage false The language in which the customer prefers to be contacted by email or SMS.
- Netflix will continue adding newer languages as and when they start supporting them.
- If the PreferredLanguages is not present or does not match the Netflix defined standard, then the language associated with the PartnerChargeCountry will be used by default.

NetflixCreateSubscriptionResponse

-

content_copy
1
2
3
{
  "id": 4567890123456789
}
Name Type Required Description
id NetflixSubscriptionId false Subscription identifier. Corresponds to the Partner Account Identifier (PAI).

NetflixCancelSubscription

-

content_copy
1
2
3
4
{
  "cancel_event_id": "c02a6e17-7bdd-4c1d-a56b-764bcd1bcf01",
  "reason": "CUSTOMER_REQUESTED_CANCEL"
}
Name Type Required Description
cancel_event_id NetflixCancelEventID true A reference for this change/transaction that can be used to track/reconcile with the trigger for this event, if any is needed in future. Max 1024 is bytes.
reason NetflixCancelReason true Indicates the reason for cancellation.

NetflixGenerateUrl

-

content_copy
1
2
3
4
5
6
7
8
{
  "channel": "WEB",
  "partner_charge_country": "ES",
  "promotion_id": "PROMO_ID",
  "token_error_url": "https://www.example.com/error/token",
  "type": "BUNDLE",
  "validity_duration_in_seconds": 43200
}
Name Type Required Description
channel NetflixBundleActivationChannel true This attribute identifies the channel that the customer uses to activate the Bundle.
partner_charge_country NetflixPartnerChargeCountry true Two letter codes that conform to ISO 3166-1
promotion_id NetflixPromotionID false PromotionID agreed upon with Netflix. This only applies to prepaid promotion integrations.
token_error_url NetflixTokenErrorURL true If a token is invalid, the customer cannot complete the bundle activation. In that case, Netflix will present a call to action where Netflix can redirect the user. You should provide the URL that corresponds with the correct page on your site where the user can restart the flow.
type NetflixTokenType true The token type indicates the purpose of the token and its intended usage.
validity_duration_in_seconds NetflixValidityDurationInSeconds false For ACCOUNT_RECOVERY token type only. This value can be up to 24 hours. The token expiration defaults to 12 hours if not provided. Please initiate the Token request once the customer has clicked on the call to action on your website and before you redirect the customer to Netflix.

NetflixGenerateUrlResponse

-

content_copy
1
2
3
4
5
{
  "expiry_date": "2023-05-20T14:32:45+02:00",
  "token": "73e90548-b839-423f-be6d-7ed715de656e",
  "requested_securitized_url": "https://www.sandbox.netflix.com/partner/home?ptoken=73e90548-b839-423f-be6d-7ed715de656e"
}
Name Type Required Description
expiry_date NetflixTokenExpiryDate false Date when token expires in ISO 8601 format.
token NetflixToken false Token value is a unique identifier based on UUID
requested_securitized_url NetflixRequestedSecuritizedUrl false RequestedSecuritizedUrl use token value to reference a Netflix url

NetflixFetchSubscriptionEventsResponse

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "events": [
    {
      "bundle_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
      "event_type": "BUNDLE_ACTIVATION",
      "netflix_event_id": "5a875d71-7deb-4693-a4d0-ae97aac9da8a",
      "netflix_offer_id": "2106f808-36e9-402d-bf37-f1f7fa04776b",
      "original_netflix_transaction_id": "e307f177-091a-4840-9830-dda1c29eea44",
      "partner_account_id": 4567890123456789,
      "partner_reference_id": "e307f177-091a-4840-9830-dda1c29eea44",
      "timestamp": 1683710542
    }
  ],
  "next_page_offset": 10
}
Name Type Required Description
events [NetflixSubscriptionEvent] false List of zero or more Event objects that are relevant to the time period defined by startTimestamp and endTimestamp
next_page_offset integer(int32) false A value that is used to retrieve subsequent pages of events that have occurred during the time period defined by the request attributes startTimestamp and endTimestamp. This value must be used to set the offset attribute for subsequent requests while using the same startTimestamp and endTimestamp.

NetflixUpdateSubscription

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "billing_event_id": "e307f177-091a-4840-9830-dda1c29eea44",
  "bundle_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
  "channel": "WEB",
  "netflix_email": "test@email.com",
  "netflix_offer_id": "2106f808-36e9-402d-bf37-f1f7fa04776b",
  "netflix_phone": "+525512345678",
  "partner_charge_country": "ES",
  "preferred_language": "es-ES"
}
Name Type Required Description
billing_event_id NetflixBillingEventID true A reference for this transaction that can be used to track or reconcile this transaction, if needed in the future. Do not use a PAI value. Maximum size is 1024 bytes.
bundle_id NetflixBundleID false Describes your bundle offers. Each of your commercial bundle offers/plans should correspond to a unique BundleID. The BundleID is generated by Netflix. You are expected to pass it in the Update API when your customer changes from one bundle to another.
channel NetflixChannel false This attribute identifies the channel that the customer uses to sign up for the Bundle.
netflix_email NetflixEmail false The primary email address preferred by the customer. Value has to be in standard email format.
- Netflix will only update the email address for the bundle enrollment if the customer has not yet activated their bundle.
- Do not pass dummy email addresses for any customer. If you do not have the customer’s primary or preferred email address, do not pass any email address.
netflix_offer_id NetflixOfferID false A pre-agreed upon UUID for each of the Netflix plans (Basic, Standard, Premium, and other Netflix plans) available in your bundle offers. This is the actual offer for which the customer will be enrolled. It must not have a value less than the Base Plan value for the associated BundleId. Note: A NetflixOfferID corresponds to one (1) Netflix streaming plan (e.g., 1S - Basic, 2S - Standard, 4S - Premium). For each NetflixOfferID, Netflix generates a Sandbox (for testing) and Production version.
netflix_phone NetflixPhone false The mobile phone number preferred by the customer. Value must be in the E.164 format. +[CountryCode][PhoneNumber]
partner_charge_country NetflixPartnerChargeCountry false Two letter codes that conform to ISO 3166-1
preferred_language NetflixPreferredLanguage false The language in which the customer prefers to be contacted by email or SMS.
- Netflix will continue adding newer languages as and when they start supporting them.
- If the PreferredLanguages is not present or does not match the Netflix defined standard, then the language associated with the PartnerChargeCountry will be used by default.

NetflixSuspend

-

content_copy
1
2
3
4
{
  "suspend_event_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
  "reason": "PAYMENT_INSTRUMENT_FAILURE"
}
Name Type Required Description
suspend_event_id string true The partner-provided reference identifier for the suspend event used for tracking.
reason string true none

NetflixUnsuspend

-

content_copy
1
2
3
{
  "unsuspend_event_id": "c2a45099-1cda-4178-83a8-02c02356ea01"
}
Name Type Required Description
unsuspend_event_id string true The partner-provided reference identifier for the unsuspend event used for tracking.

NetflixBillingEventID

-

content_copy
1
"e307f177-091a-4840-9830-dda1c29eea44"
Name Type Required Description
anonymous string false A reference for this transaction that can be used to track or reconcile this transaction, if needed in the future. Do not use a PAI value. Maximum size is 1024 bytes.

NetflixBundleActivationChannel

-

Name Type Required Description
anonymous string false This attribute identifies the channel that the customer uses to activate the Bundle.

NetflixBundleID

-

content_copy
1
"c2a45099-1cda-4178-83a8-02c02356ea01"
Name Type Required Description
anonymous string false Describes your bundle offers. Each of your commercial bundle offers/plans should correspond to a unique BundleID. The BundleID is generated by Netflix. You are expected to pass it in the Update API when your customer changes from one bundle to another.

NetflixCancelEventID

-

content_copy
1
"c02a6e17-7bdd-4c1d-a56b-764bcd1bcf01"
Name Type Required Description
anonymous string false A reference for this change/transaction that can be used to track/reconcile with the trigger for this event, if any is needed in future. Max 1024 is bytes.

NetflixCancelReason

-

content_copy
1
"CUSTOMER_REQUESTED_CANCEL"
Name Type Required Description
anonymous string false Indicates the reason for cancellation.

NetflixChannel

-

Name Type Required Description
anonymous string false This attribute identifies the channel that the customer uses to sign up for the Bundle.

NetflixEmail

-

content_copy
1
"test@email.com"
Name Type Required Description
anonymous string false The primary email address preferred by the customer. Value has to be in standard email format.
- Netflix will only update the email address for the bundle enrollment if the customer has not yet activated their bundle.
- Do not pass dummy email addresses for any customer. If you do not have the customer’s primary or preferred email address, do not pass any email address.

NetflixOfferID

-

content_copy
1
"2106f808-36e9-402d-bf37-f1f7fa04776b"
Name Type Required Description
anonymous string false A pre-agreed upon UUID for each of the Netflix plans (Basic, Standard, Premium, and other Netflix plans) available in your bundle offers. This is the actual offer for which the customer will be enrolled. It must not have a value less than the Base Plan value for the associated BundleId. Note: A NetflixOfferID corresponds to one (1) Netflix streaming plan (e.g., 1S - Basic, 2S - Standard, 4S - Premium). For each NetflixOfferID, Netflix generates a Sandbox (for testing) and Production version.

NetflixPartnerAccountId

-

content_copy
1
4567890123456789
Name Type Required Description
anonymous string false Partner Account Identifier (PAI) to associate an account in your system with a Netflix account.

NetflixPartnerChargeCountry

-

Name Type Required Description
anonymous string false Two letter codes that conform to ISO 3166-1

NetflixPhone

-

content_copy
1
"+525512345678"
Name Type Required Description
anonymous string false The mobile phone number preferred by the customer. Value must be in the E.164 format. +[CountryCode][PhoneNumber]

NetflixPreferredLanguage

-

Name Type Required Description
anonymous string false The language in which the customer prefers to be contacted by email or SMS.
- Netflix will continue adding newer languages as and when they start supporting them.
- If the PreferredLanguages is not present or does not match the Netflix defined standard, then the language associated with the PartnerChargeCountry will be used by default.

NetflixPromotionID

-

content_copy
1
"PROMO_ID"
Name Type Required Description
anonymous string false PromotionID agreed upon with Netflix. This only applies to prepaid promotion integrations.

NetflixSubscriptionEvent

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "bundle_id": "c2a45099-1cda-4178-83a8-02c02356ea01",
  "event_type": "BUNDLE_ACTIVATION",
  "netflix_event_id": "5a875d71-7deb-4693-a4d0-ae97aac9da8a",
  "netflix_offer_id": "2106f808-36e9-402d-bf37-f1f7fa04776b",
  "original_netflix_transaction_id": "e307f177-091a-4840-9830-dda1c29eea44",
  "partner_account_id": 4567890123456789,
  "partner_reference_id": "e307f177-091a-4840-9830-dda1c29eea44",
  "timestamp": 1683710542
}
Name Type Required Description
bundle_id NetflixBundleID false Describes your bundle offers. Each of your commercial bundle offers/plans should correspond to a unique BundleID. The BundleID is generated by Netflix. You are expected to pass it in the Update API when your customer changes from one bundle to another.
event_type string false Type of subscription event. The value must match one of the predefined SubscriptionEventType values. Future releases may add new values without breaking backward compatibility.
netflix_event_id string false An ID that uniquely identifies an event. This ID can be used for deduplication.
netflix_offer_id NetflixOfferID false A pre-agreed upon UUID for each of the Netflix plans (Basic, Standard, Premium, and other Netflix plans) available in your bundle offers. This is the actual offer for which the customer will be enrolled. It must not have a value less than the Base Plan value for the associated BundleId. Note: A NetflixOfferID corresponds to one (1) Netflix streaming plan (e.g., 1S - Basic, 2S - Standard, 4S - Premium). For each NetflixOfferID, Netflix generates a Sandbox (for testing) and Production version.
original_netflix_transaction_id string false This field is dependent on the type of event:
- For the BUNDLE_PLAN_CHANGE event type, this field represents the NetflixTransactionID associated with the change event when a customer updated their Netflix plan via Netflix.
- For the BUNDLE_SUSPENSION event type, this field represents the NetflixTransactionID that was returned by Netflix in response to the Suspend API request.
- For the BUNDLE_UNSUSPENSION event type, this field represents the NetflixTransactionID that was returned by Netflix in response to the Suspend API request.
partner_account_id NetflixPartnerAccountId false Partner Account Identifier (PAI) to associate an account in your system with a Netflix account.
partner_reference_id string false This field is dependent on the type of event:
- For the BUNDLE_ENROLLMENT event type, this field represents the BillingEventID associated with the original Enroll API request that resulted in Netflix creating a new bundle for the customer.
- For the BUNDLE_PLAN_CHANGE event type, this field represents the BillingEventID associated with the original Enroll API request that resulted in Netflix creating a new bundle for the customer. This applies when the plan change was initiated for and on-behalf of the customer via your website/CS.
- For the BUNDLE_CANCELLATION event type, this field represents the CancelEventID associated with the original Cancel API request.
- For the BUNDLE_SUSPENSION event type, this field represents the NetflixTransactionID that was returned by Netflix in response to the Suspend API request.
- For the BUNDLE_UNSUSPENSION event type, this field represents the SuspendEventID associated with the original Suspend API request.
timestamp integer(int64) false Represents the time (milliseconds since the UNIX epoch) at which the event occurred.

NetflixSubscriptionEventType

-

content_copy
1
"BUNDLE_ACTIVATION"
Name Type Required Description
anonymous string false Subscription event type

NetflixSubscriptionId

-

content_copy
1
4567890123456789
Name Type Required Description
anonymous string false Subscription identifier. Corresponds to the Partner Account Identifier (PAI).

NetflixToken

-

content_copy
1
"73e90548-b839-423f-be6d-7ed715de656e"
Name Type Required Description
anonymous string false Token value is a unique identifier based on UUID

NetflixRequestedSecuritizedUrl

-

content_copy
1
"https://www.sandbox.netflix.com/partner/home?ptoken=73e90548-b839-423f-be6d-7ed715de656e"
Name Type Required Description
anonymous string false RequestedSecuritizedUrl use token value to reference a Netflix url

NetflixTokenErrorURL

-

content_copy
1
"https://www.example.com/error/token"
Name Type Required Description
anonymous string false If a token is invalid, the customer cannot complete the bundle activation. In that case, Netflix will present a call to action where Netflix can redirect the user. You should provide the URL that corresponds with the correct page on your site where the user can restart the flow.

NetflixTokenExpiryDate

-

content_copy
1
"2023-05-20T14:32:45+02:00"
Name Type Required Description
anonymous string false Date when token expires in ISO 8601 format.

NetflixTokenType

-

Name Type Required Description
anonymous string false The token type indicates the purpose of the token and its intended usage.

NetflixValidityDurationInSeconds

-

Name Type Required Description
anonymous integer(int32) false For ACCOUNT_RECOVERY token type only. This value can be up to 24 hours. The token expiration defaults to 12 hours if not provided. Please initiate the Token request once the customer has clicked on the call to action on your website and before you redirect the customer to Netflix.

NetflixGetSubscriptionStatusResponse

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "has_partner_mop": true,
  "product_type": "string",
  "subscription": {
    "plan": {
      "localized_type": "string",
      "type": "string"
    }
  },
  "bundle": {
    "id": "string",
    "offer_id": "string",
    "status": "string"
  }
}
Name Type Required Description
has_partner_mop boolean false none
product_type string false none
subscription NetflixSubscription false none
bundle NetflixBundle false none

NetflixSubscription

-

content_copy
1
2
3
4
5
6
{
  "plan": {
    "localized_type": "string",
    "type": "string"
  }
}
Name Type Required Description
plan NetflixPlan false none

NetflixPlan

-

content_copy
1
2
3
4
{
  "localized_type": "string",
  "type": "string"
}
Name Type Required Description
localized_type string false none
type string false none

NetflixBundle

-

content_copy
1
2
3
4
5
{
  "id": "string",
  "offer_id": "string",
  "status": "string"
}
Name Type Required Description
id string false none
offer_id string false none
status string false none

HboCreateSubscription

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "service_id": 1234567890123456,
  "external_id": 1234567890123456,
  "country": "ES",
  "product_code": "HBO",
  "product_name": "HBO",
  "product_start_date": "2021-01-01T00:00:00Z",
  "product_expire_date": "2021-01-01T00:00:00Z",
  "product_renew_date": "2021-01-01T00:00:00Z"
}
Name Type Required Description
service_id HboServiceId true Service identifier in HBO. Corresponds to Subscription Id.
external_id HboExternalId true Partner user identifier in HBO. It’s the Id in CRM.
country HboCountry true Country code. ISO 3166-1 alpha-2 code.
product_code HboProductCode true Product code
product_name HboProductName false Product name
product_start_date HboProductStartDate true Product start date
product_expire_date HboProductExpireDate false Product expire date
product_renew_date HboProductRenewDate false Product renew date

HboCreateSubscriptionResponse

-

content_copy
1
2
3
4
5
{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}
None

HboCancelSubscription

-

content_copy
1
2
3
4
5
6
{
  "external_id": 1234567890123456,
  "reason": "PRODUCT_CANCELED",
  "product_code": "HBO",
  "product_expire_date": "2021-01-01T00:00:00Z"
}
Name Type Required Description
external_id HboExternalId true Partner user identifier in HBO. It’s the Id in CRM.
reason HboReason true Reason for the cancellation
product_code HboProductCode true Product code
product_expire_date HboProductExpireDate false Product expire date

HboCancelSubscriptionResponse

-

content_copy
1
2
3
4
5
{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}
None

HboGenerateActivationUrl

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "external_id": 1234567890123456,
  "country": "ES",
  "product_code": "HBO",
  "product_name": "HBO",
  "product_start_date": "2021-01-01T00:00:00Z",
  "product_expire_date": "2021-01-01T00:00:00Z",
  "product_renew_date": "2021-01-01T00:00:00Z",
  "transaction_id": 4567890123456789
}
Name Type Required Description
external_id HboExternalId true Partner user identifier in HBO. It’s the Id in CRM.
country HboCountry false Country code. ISO 3166-1 alpha-2 code.
product_code HboProductCode true Product code
product_name HboProductName false Product name
product_start_date HboProductStartDate true Product start date
product_expire_date HboProductExpireDate false Product expire date
product_renew_date HboProductRenewDate false Product renew date
transaction_id HboTransactionId false ID of the transaction that granted the user access to the product.

HboGenerateActivationURLResponse

-

content_copy
1
2
3
{
  "url": "https://www.example.com/activation/123"
}
Name Type Required Description
url HboActivationURL false Activation URL.

WorkflowResponse

-

content_copy
1
2
3
4
5
{
  "message": "message",
  "workflowId": "workflowId",
  "runId": "workflowId"
}
Name Type Required Description
message string false none
workflowId string false none
runId string false none

HboServiceId

-

content_copy
1
1234567890123456
Name Type Required Description
anonymous string false Service identifier in HBO. Corresponds to Subscription Id.

HboExternalId

-

content_copy
1
1234567890123456
Name Type Required Description
anonymous string false Partner user identifier in HBO. It’s the Id in CRM.

HboCountry

-

Name Type Required Description
anonymous string false Country code. ISO 3166-1 alpha-2 code.

HboProductCode

-

Name Type Required Description
anonymous string false Product code

HboProductName

-

Name Type Required Description
anonymous string false Product name

HboProductStartDate

-

content_copy
1
"2021-01-01T00:00:00Z"
Name Type Required Description
anonymous string(date-time) false Product start date

HboProductExpireDate

-

content_copy
1
"2021-01-01T00:00:00Z"
Name Type Required Description
anonymous string(date-time) false Product expire date

HboProductRenewDate

-

content_copy
1
"2021-01-01T00:00:00Z"
Name Type Required Description
anonymous string(date-time) false Product renew date

HboReason

-

content_copy
1
"PRODUCT_CANCELED"
Name Type Required Description
anonymous string false Reason for the cancellation
Property Values
anonymous one of [PRODUCT_CANCELED, PRODUCT_CHANGED, OFFER_EXPIRED]

HboActivationURL

-

content_copy
1
"https://www.example.com/activation/123"
Name Type Required Description
anonymous string false Activation URL.

HboTransactionId

-

content_copy
1
4567890123456789
Name Type Required Description
anonymous string false ID of the transaction that granted the user access to the product.

FtthOrangeAccessResponse

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "address": "address",
  "brand": "brand",
  "cVlan": "cVlan",
  "code": "code",
  "cto": "cto",
  "ctoAddress": "ctoAddress",
  "ctoLocation": "ctoLocation",
  "ctoPort": "ctoPort",
  "ctoType": "ctoType",
  "derivationBoxCode": "derivationBoxCode",
  "derivationBoxLocation": "derivationBoxLocation",
  "description": "description",
  "deviceBrand": "deviceBrand",
  "deviceModel": "deviceModel",
  "documentNumber": "documentNumber",
  "documentType": "documentType",
  "footprint": "footprint",
  "gescal37": "gescal37",
  "idAddressTo": "idAddressTo",
  "iptv": "iptv",
  "iua": "iua",
  "iuaBillingWholesale": "iuaBilling",
  "lagAdministrative": "valores#valores",
  "message": "message",
  "modality": "modality",
  "oltCard": "oltCard",
  "oltCode": "oltCode",
  "oltModel": "oltModel",
  "oltPort": "oltPort",
  "ontId": "ontId",
  "ontManufacturer": "ont",
  "ontPassword": "ontPassword",
  "phoneNumber": "phoneNumber",
  "ppai": "ppai",
  "sVlan": "sVlan",
  "splitterId": "splitterId",
  "splitterType": "splitterType",
  "tv": "tv",
  "verticalManager": "verticalManager"
}
Name Type Required Description
address string false none
brand string false none
cVlan string false none
code string false none
cto string false none
ctoAddress string false none
ctoLocation string false none
ctoPort string false none
ctoType string false none
derivationBoxCode string false none
derivationBoxLocation string false none
description string false none
deviceBrand string false none
deviceModel string false none
documentNumber string false none
documentType string false none
footprint string false none
gescal37 string false none
idAddressTo string false none
iptv string false none
iua string false none
iuaBillingWholesale string false none
lagAdministrative string false none
message string false none
modality string false none
oltCard string false none
oltCode string false none
oltModel string false none
oltPort string false none
ontId string false none
ontManufacturer string false none
ontPassword string false none
phoneNumber string false none
ppai string false none
sVlan string false none
splitterId string false none
splitterType string false none
tv string false none
verticalManager string false none

GetFtthAccesesInfoResponse

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
  "brand": "yoigo",
  "footprint": "yoigo",
  "phone_number": "600000000",
  "document": "11111111K",
  "document_type": "NIF",
  "iua": "M15904010OS7",
  "gescal": "15000181339400017         004DCHA    ",
  "address": "Calle las flores,5, Madrid, 28000",
  "tv": "true",
  "domicile_id": "MR000000000000000000000000000000812874",
  "cto": "FE6013110C020",
  "cto_type": "CTO 8",
  "cto_location": "NATURAIS DE FENE 17, AVENIDA",
  "cto_install_type": "FACHADA",
  "splitter": "110020.1",
  "splitter_type": "1:16",
  "cto_port": 1,
  "cd": "string",
  "cd_type": "INDEFINIDO",
  "cd_location": "INDEFINIDO",
  "olt": "107FE60131",
  "olt_type": "C600",
  "olt_sw_version": "V100R019C10SPH210",
  "olt_card": 3,
  "gpon_port": 8,
  "ont_id": 2,
  "tesa_ont_id": "2890384092f",
  "ont_password": "812874",
  "ppai": "M1599959",
  "template": "1000M_1000M_TV_RES_XPM-DHCP_EKT",
  "remote_id": "RD20721131812874",
  "remote_id_tv": "string",
  "vertical_manager": "904",
  "vlan": 1000,
  "s_vlan": 1000,
  "c_vlan": 1000,
  "device_brand": "SCOMFG824CDv2M",
  "device_model": "FG824CD",
  "fw_version": "FG824MM3115",
  "serial_number": "2183128443",
  "device_identity": "2183128443",
  "iua_wholesaler_fact": "11650007043333",
  "administrative_lag": "v1165002#1",
  "modality": "300M_300M"
}
Name Type Required Description
brand string false none
footprint string false none
phone_number string false none
document string false none
document_type string false none
iua string false none
gescal string false none
address string false none
tv boolean false indicates wether its has service or not
domicile_id string false none
cto string false none
cto_type string false none
cto_location string false none
cto_install_type string false none
splitter string false none
splitter_type string false none
cto_port integer false none
cd string false none
cd_type string false none
cd_location string false none
olt string false none
olt_type string false none
olt_sw_version string false none
olt_card integer false none
gpon_port integer false none
ont_id integer false none
tesa_ont_id string false none
ont_password string false none
ppai string false none
template string false none
remote_id string false none
remote_id_tv string false none
vertical_manager string false none
vlan integer false none
s_vlan integer false none
c_vlan integer false none
device_brand string false none
device_model string false none
fw_version string false none
serial_number string false none
device_identity string false none
iua_wholesaler_fact string false none
administrative_lag string false none
modality string false none

RetentionsRequest

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "reuseAccess": true,
  "source": {
    "gescal37": "string",
    "iua": "string",
    "phoneNumber": "string",
    "documentNumber": "string",
    "clientName": "string",
    "brand": "string"
  },
  "destination": {
    "gescal37": "string",
    "iua": "string",
    "phoneNumber": "string",
    "documentNumber": "string",
    "clientName": "string",
    "brand": "string",
    "bandwidth": "string",
    "customerType": "string",
    "tv": "OTT"
  }
}
Name Type Required Description
reuseAccess boolean true Reuse access
source object false none
» gescal37 string false Gescal37 of the source client. Mandatory if reuseAccess=“true”
» iua string false IUA of the source client. Mandatory if reuseAccess=“true”
» phoneNumber string false Phone number of the source client. Mandatory if reuseAccess=“true”
» documentNumber string false Document number of the source client. Mandatory if reuseAccess=“true”
» clientName string false Client name of the source client. Mandatory if reuseAccess=“true”
» brand string false Brand of the source client. Mandatory if reuseAccess=“true”
destination object true none
» gescal37 string true Gescal37 of the destination client
» iua string false IUA of the destination client
» phoneNumber string false Phone number of the destination client
» documentNumber string false Document number of the destination client
» clientName string false Client name of the destination client
» brand string true Brand of the destination client
» bandwidth string true Contracted speed
» customerType string true Segment of the destination client
» tv string false TV contracted of the destination brand. Allowed values: OTT,IPTV,IPTV+OTT

RetentionsResponse

-

content_copy
1
2
3
4
5
{
  "code": "000",
  "description": "Operation successful",
  "message": "OK"
}
Name Type Required Description
code string false Code identifying the possible results of the operation
description string false Displays the code description of the result obtained
message string false OK/KO

InsuranceCreationRequestDTO

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "documentId": "00000000F",
  "firstName": "juan",
  "lastName1": "perez",
  "lastName2": "perez",
  "msisdn": "666666666",
  "address": "paseo de castellana, 4, 002B",
  "email": "d@g.com",
  "zipCode": "28000",
  "locality": "madrid",
  "province": "madrid",
  "language": "allowed values: es => castellano, eu=> euskera, ga=>gallego, ca=>catalán",
  "sfid": "1234",
  "telcoBrand": "Masmovil",
  "brand": "string",
  "model": "string",
  "price": 2.2,
  "clientType": "Autónomo",
  "invoicePayment": true,
  "productType": "Móvil",
  "imei": "string",
  "terminalSaleDate": "2022-01-31T23:00:00Z",
  "entity": "string",
  "officeCode": "string",
  "dc": "string",
  "accountNumber": "string"
}
Name Type Required Description
documentId string false none
firstName string false none
lastName1 string false none
lastName2 string false none
msisdn string false none
address string false none
email string false none
zipCode string false none
locality string false none
province string false none
language string false none
sfid string false none
telcoBrand string false none
brand string false none
model string false none
price number false none
clientType string false none
invoicePayment boolean false none
productType string false none
imei string false none
terminalSaleDate string(date) false none
entity string false none
officeCode string false none
dc string false none
accountNumber string false none

InsuranceCreationResponseDTO

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "requestId": "string",
  "policyNumber": "string",
  "monthlyFee": 2.2,
  "annualFee": 2.2,
  "franchise": true,
  "franchiseAmount": 2.2,
  "theft": true,
  "monthlyNetFee": 2.2,
  "annualNetFee": 2.2,
  "annualLea": 2.2,
  "monthlyLea": 2.2,
  "annualIps": 2.2,
  "monthlyIps": 2.2,
  "annualConsortium": 2.2,
  "monthlyConsortium": 2.2,
  "firstAnnualLea": 2.2,
  "firstMonthlyConsortium": 2.2,
  "firstAnnualIps": 2.2,
  "firstAnnualNetFee": 2.2,
  "firstAnnualFee": 2.2
}
Name Type Required Description
requestId string false none
policyNumber string false none
monthlyFee number false none
annualFee number false none
franchise boolean false none
franchiseAmount number false none
theft boolean false none
monthlyNetFee number false none
annualNetFee number false none
annualLea number false none
monthlyLea number false none
annualIps number false none
monthlyIps number false none
annualConsortium number false none
monthlyConsortium number false none
firstAnnualLea number false none
firstMonthlyConsortium number false none
firstAnnualIps number false none
firstAnnualNetFee number false none
firstAnnualFee number false none

InsuranceIssueRequestDTO

-

content_copy
1
2
3
4
5
6
7
8
{
  "requestId": "00000000JIUSCS",
  "policyNumber": "87912HDH",
  "imei": "imei",
  "msisdn": "666666666",
  "document": "000000000K",
  "subscriptionId": "SNMC893CNIE"
}
Name Type Required Description
requestId string false none
policyNumber string false none
imei string false none
msisdn string false none
document string false none
subscriptionId string false none

InsuranceIssueResponseDTO

-

content_copy
1
2
3
4
5
6
7
8
9
{
  "requestId": "string",
  "policyNumber": "string",
  "monthlyFee": 2.2,
  "annualFee": 2.2,
  "franchise": true,
  "franchiseAmount": 2.2,
  "theft": true
}
Name Type Required Description
requestId string false none
policyNumber string false none
monthlyFee number false none
annualFee number false none
franchise boolean false none
franchiseAmount number false none
theft boolean false none

InsuranceCancellationRequestDTO

-

content_copy
1
2
3
4
5
{
  "policyNumber": "87912HDH",
  "document": "000000000K",
  "reason": "Reason is..."
}
Name Type Required Description
policyNumber string false none
document string false none
reason string false none

InsuranceCancellationResponseDTO

-

content_copy
1
2
3
{
  "result": true
}
Name Type Required Description
result boolean false none

InsuranceInfoResponseDTO

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "certificateNumber": "string",
  "imei": "string",
  "brand": {
    "name": "string"
  },
  "model": {
    "description": "string"
  },
  "phoneNumber": "string",
  "document": "string",
  "firstName": "string",
  "lastName1": "string",
  "lastName2": "string",
  "address": "string",
  "number": "string",
  "city": "string",
  "zipCode": "string",
  "policyNumber": "string",
  "province": "string",
  "effectiveDate": "2022-01-31T23:00:00Z",
  "email": "string",
  "sold": true,
  "cancelled": true,
  "cancellationDate": "2022-01-31T23:00:00Z",
  "serialNumber": "string",
  "paymentMethod": {
    "description": "string"
  },
  "clientType": {
    "name": "string"
  },
  "billPayment": true,
  "withdrawal": true,
  "withdrawalDate": "2022-01-31T23:00:00Z",
  "emitted": true,
  "language": {
    "name": "string"
  },
  "accident": true
}
Name Type Required Description
certificateNumber string false none
imei string false none
brand NameDTO false none
model DescriptionDTO false none
phoneNumber string false none
document string false none
firstName string false none
lastName1 string false none
lastName2 string false none
address string false none
number string false none
city string false none
zipCode string false none
policyNumber string false none
province string false none
effectiveDate string(date) false none
email string false none
sold boolean false none
cancelled boolean false none
cancellationDate string(date) false none
serialNumber string false none
paymentMethod DescriptionDTO false none
clientType NameDTO false none
billPayment boolean false none
withdrawal boolean false none
withdrawalDate string(date) false none
emitted boolean false none
language NameDTO false none
accident boolean false none

NameDTO

-

content_copy
1
2
3
{
  "name": "string"
}
Name Type Required Description
name string false none

DescriptionDTO

-

content_copy
1
2
3
{
  "description": "string"
}
Name Type Required Description
description string false none

errorResponseDtoDeviceInsurance

-

content_copy
1
2
3
4
{
  "code": "string",
  "message": "string"
}
Name Type Required Description
code string false none
message string false none

errorResponseDto

-

content_copy
1
2
3
4
5
{
  "result": "string",
  "error_code": "string",
  "error_description": "string"
}
Name Type Required Description
result string false none
error_code string false none
error_description string false none

ActivateSubscription

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "email": "email@emil.com",
  "firstName": "First name",
  "lastName": "Last name",
  "ftthWorkOrderId": "MYSIM_123456",
  "maxStb": "Max stb",
  "maxTerminals": "max terminals",
  "password": "pass1234",
  "postalCode": 987564,
  "segment": "Segment",
  "phoneNumber": 40828383874,
  "spId": "spId",
  "spendingLimit": 1234554,
  "customerType": "iptv/ott",
  "servicePlan": [
    "spId-1",
    "spId-2",
    "spId-3"
  ],
  "externalID": "external_subscription_12345",
  "ftthServiceID": "ftth_service_67890"
}
Name Type Required Description
email Email false Email
firstName FirstName true First Name
lastName LastName true Last name
ftthWorkOrderId FtthWorkOrderId false FTTH work order identifier
maxStb MaxStb false Max stb
maxTerminals MaxTerminals true Max terminals
password Password false password
postalCode PostalCode false Postal code
segment Segment false Segment
phoneNumber PhoneNumber false Phone number
spId SpId true Sp id
spendingLimit SpendingLimit false Spending limit
customerType CustomerType true Customer type
servicePlan ServicePlan false Service plan for creation without FTTH
externalID ExternalID false Identifier of the subscription on the CRM
ftthServiceID FtthServiceID false For north brands where we don’t have the order on wo_data, we use ftthServiceId.

ModifySubscription

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "segment": "Segment",
  "servicePlanToAdd": [
    "spId-1",
    "spId-2",
    "spId-3"
  ],
  "servicePlanToDelete": [
    "spId-1",
    "spId-2",
    "spId-3"
  ]
}
Name Type Required Description
segment Segment false Segment
servicePlanToAdd ServicePlanToAdd true Service type list to add
servicePlanToDelete ServicePlanToDelete true Service type list to delete

ModifyCustomer

-

content_copy
1
2
3
4
5
6
7
8
{
  "ftthWorkOrderId": "MYSIM_123456",
  "password": "pass1234",
  "parentalPin": "1234",
  "email": "email@emil.com",
  "postalCode": 987564,
  "spendingLimit": 1234554
}
Name Type Required Description
ftthWorkOrderId FtthWorkOrderId false FTTH work order identifier
password Password false password
parentalPin ParentalPin false Parental PIN
email Email false Email
postalCode PostalCode false Postal code
spendingLimit SpendingLimit false Spending limit

CancelSubscriptionRequest

-

content_copy
1
2
3
{
  "creationWorkflowId": "provision_OrangeTvActivationWf_33348e03-7b85-4cf9-a933-a04e74766acb"
}
Name Type Required Description
creationWorkflowId string true none

GetDevicesResponse

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
[
  {
    "macAddress": "string",
    "name": "string",
    "modelExternalId": "string",
    "registrationDate": "string",
    "serialNumber": "string",
    "vua": "string",
    "stbSn": "string"
  }
]
Name Type Required Description
anonymous [Terminal] false none

Terminal

-

content_copy
1
2
3
4
5
6
7
8
9
{
  "macAddress": "string",
  "name": "string",
  "modelExternalId": "string",
  "registrationDate": "string",
  "serialNumber": "string",
  "vua": "string",
  "stbSn": "string"
}
Name Type Required Description
macAddress string false none
name string false none
modelExternalId string false none
registrationDate string false none
serialNumber string false none
vua string false none
stbSn string false none

CustomerType

-

content_copy
1
"iptv/ott"
Name Type Required Description
anonymous string false Customer type

Email

-

content_copy
1
"email@emil.com"
Name Type Required Description
anonymous string false Email

FirstName

-

content_copy
1
"First name"
Name Type Required Description
anonymous string false First Name

LastName

-

content_copy
1
"Last name"
Name Type Required Description
anonymous string false Last name

MaxStb

-

content_copy
1
"Max stb"
Name Type Required Description
anonymous string false Max stb

MaxTerminals

-

content_copy
1
"max terminals"
Name Type Required Description
anonymous string false Max terminals

PhoneNumber

-

content_copy
1
40828383874
Name Type Required Description
anonymous string false Phone number

PostalCode

-

Name Type Required Description
anonymous string false Postal code

Segment

-

content_copy
1
"Segment"
Name Type Required Description
anonymous string false Segment
Property Values
anonymous one of [CONSUMER]

SpendingLimit

-

Name Type Required Description
anonymous number false Spending limit

SpId

-

Name Type Required Description
anonymous string false Sp id

FtthWorkOrderId

-

content_copy
1
"MYSIM_123456"
Name Type Required Description
anonymous string false FTTH work order identifier

ServicePlanToAdd

-

content_copy
1
2
3
4
5
[
  "spId-1",
  "spId-2",
  "spId-3"
]
None

ServicePlanToDelete

-

content_copy
1
2
3
4
5
[
  "spId-1",
  "spId-2",
  "spId-3"
]
None

Password

-

content_copy
1
"pass1234"
Name Type Required Description
anonymous string false password

ParentalPin

-

Name Type Required Description
anonymous string false Parental PIN

ServicePlan

-

content_copy
1
2
3
4
5
[
  "spId-1",
  "spId-2",
  "spId-3"
]
None

ExternalID

-

content_copy
1
"external_subscription_12345"
Name Type Required Description
anonymous string false Identifier of the subscription on the CRM

FtthServiceID

-

content_copy
1
"ftth_service_67890"
Name Type Required Description
anonymous string false For north brands where we don’t have the order on wo_data, we use ftthServiceId.

TesaActivationRequest

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
  "territoryOwner": "NEBA",
  "portabilityIndicator": "D",
  "externalReference": "string",
  "technicalCoordinators": {
    "name": "string",
    "surnames": "string",
    "phoneNumbers": {
      "principal": "string",
      "alternative": "string"
    },
    "emails": {
      "principal": "string",
      "alternative": "string"
    },
    "fax": "string"
  },
  "customer": {
    "name": "string",
    "surnames": "string",
    "segment": "B2C",
    "phoneNumbers": {
      "principal": "string",
      "alternative": "string"
    }
  },
  "servicePoint": {
    "gescal": "string",
    "comments": "string",
    "iua": "string",
    "ppai": "string",
    "opVlan": "string",
    "speed": {
      "upload": "string",
      "download": "string"
    },
    "installation": {
      "ptro": true,
      "ont": "N"
    },
    "maintenance": {
      "indicator": true,
      "type": "DSI"
    },
    "portability": {
      "phoneNumber": "string",
      "documentType": "L",
      "documentNumber": "string",
      "accessType": "01",
      "nrn": "string",
      "phoneRange": {
        "initial": "string",
        "final": "string"
      },
      "wholeNumbering": true,
      "resellerDonor": {
        "name": "string",
        "document": "string"
      },
      "resellerRecipient": {
        "name": "string",
        "document": "string"
      }
    }
  }
}
Name Type Required Description
territoryOwner string true Territory owner:
* NEBA - Neba
* VULA_COMMERCIAL - Vula commercial
* VULA_REGULATED - Vula regulated
portabilityIndicator string false Portability type:
* D - Donor
* T - Third party
* N - Without portability
* A - Agreement
externalReference string true none
technicalCoordinators TesaTechnicalCoordinators true none
customer TesaCustomer true none
servicePoint TesaServicePoint true none
Property Values
territoryOwner one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED]
portabilityIndicator one of [D, T, N, A]

TesaTechnicalCoordinators

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "name": "string",
  "surnames": "string",
  "phoneNumbers": {
    "principal": "string",
    "alternative": "string"
  },
  "emails": {
    "principal": "string",
    "alternative": "string"
  },
  "fax": "string"
}
Name Type Required Description
name string true none
surnames string true none
phoneNumbers TesaPhoneNumbers true none
emails TesaEmails true none
fax string true none

TesaCustomer

-

content_copy
1
2
3
4
5
6
7
8
9
{
  "name": "string",
  "surnames": "string",
  "segment": "B2C",
  "phoneNumbers": {
    "principal": "string",
    "alternative": "string"
  }
}
Name Type Required Description
name string true none
surnames string true none
segment string true Territory owner:
* B2C - Consumer
* B2B - Business
* B2B2C - Business to business to consumer
phoneNumbers TesaPhoneNumbers true none
Property Values
segment one of [B2C, B2B, B2B2C]

TesaServicePoint

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "gescal": "string",
  "comments": "string",
  "iua": "string",
  "ppai": "string",
  "opVlan": "string",
  "speed": {
    "upload": "string",
    "download": "string"
  },
  "installation": {
    "ptro": true,
    "ont": "N"
  },
  "maintenance": {
    "indicator": true,
    "type": "DSI"
  },
  "portability": {
    "phoneNumber": "string",
    "documentType": "L",
    "documentNumber": "string",
    "accessType": "01",
    "nrn": "string",
    "phoneRange": {
      "initial": "string",
      "final": "string"
    },
    "wholeNumbering": true,
    "resellerDonor": {
      "name": "string",
      "document": "string"
    },
    "resellerRecipient": {
      "name": "string",
      "document": "string"
    }
  }
}
Name Type Required Description
gescal string false none
comments string false none
iua string false none
ppai string false none
opVlan string false none
speed TesaSpeed true none
installation TesaInstallation true none
maintenance TesaMaintenance true none
portability TesaPortability false none

TesaResult

-

content_copy
1
2
3
{
  "message": "string"
}
Name Type Required Description
message string false none

TesaPhoneNumbers

-

content_copy
1
2
3
4
{
  "principal": "string",
  "alternative": "string"
}
Name Type Required Description
principal string true none
alternative string true none

TesaEmails

-

content_copy
1
2
3
4
{
  "principal": "string",
  "alternative": "string"
}
Name Type Required Description
principal string true none
alternative string true none

TesaSpeed

-

content_copy
1
2
3
4
{
  "upload": "string",
  "download": "string"
}
Name Type Required Description
upload string true none
download string true none

TesaMaintenance

-

content_copy
1
2
3
4
{
  "indicator": true,
  "type": "DSI"
}
Name Type Required Description
indicator boolean true none
type string false Maintenance type:
* DSI - Next day
Property Values
type one of [DSI]

TesaInstallation

-

content_copy
1
2
3
4
{
  "ptro": true,
  "ont": "N"
}
Name Type Required Description
ptro boolean true none
ont string true Document type:
* N - No
* R - Resale
Property Values
ont one of [N, R]

TesaPortability

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "phoneNumber": "string",
  "documentType": "L",
  "documentNumber": "string",
  "accessType": "01",
  "nrn": "string",
  "phoneRange": {
    "initial": "string",
    "final": "string"
  },
  "wholeNumbering": true,
  "resellerDonor": {
    "name": "string",
    "document": "string"
  },
  "resellerRecipient": {
    "name": "string",
    "document": "string"
  }
}
Name Type Required Description
phoneNumber string false none
documentType string false Document type:
* L - CIF
* D - DNI
* R - NIE
* P - Passport
documentNumber string false none
accessType string false Document type:
* 01 - INDIVIDUAL
* 03 - MULTIPLE
nrn string false none
phoneRange TesaPhoneRange false none
wholeNumbering boolean false none
resellerDonor TesaReseller false none
resellerRecipient TesaReseller false none
Property Values
documentType one of [L, D, R, P]
accessType one of [01, 03]

TesaPhoneRange

-

content_copy
1
2
3
4
{
  "initial": "string",
  "final": "string"
}
Name Type Required Description
initial string true none
final string true none

TesaReseller

-

content_copy
1
2
3
4
{
  "name": "string",
  "document": "string"
}
Name Type Required Description
name string true none
document string true none

TesaTerminationRequest

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "territoryOwner": "NEBA",
  "externalReference": "string",
  "technicalCoordinators": {
    "name": "string",
    "surnames": "string",
    "phoneNumbers": {
      "principal": "string",
      "alternative": "string"
    },
    "emails": {
      "principal": "string",
      "alternative": "string"
    },
    "fax": "string"
  },
  "customer": {
    "name": "string",
    "surnames": "string",
    "segment": "B2C",
    "phoneNumbers": {
      "principal": "string",
      "alternative": "string"
    }
  },
  "servicePoint": {
    "iua": "string",
    "administrative": "string"
  }
}
Name Type Required Description
territoryOwner string true Territory owner:
* NEBA - Neba
* VULA_COMMERCIAL - Vula commercial
* VULA_REGULATED - Vula regulated
externalReference string true none
technicalCoordinators TesaTechnicalCoordinators true none
customer TesaCustomer true none
servicePoint TesaTerminationServicePoint true none
Property Values
territoryOwner one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED]

TesaTerminationServicePoint

-

content_copy
1
2
3
4
{
  "iua": "string",
  "administrative": "string"
}
Name Type Required Description
iua string true none
administrative string false none

TesaCancellationRequest

-

content_copy
1
2
3
{
  "externalReference": "string"
}
Name Type Required Description
externalReference string true none

TesaIncidentResolveRequest

-

content_copy
1
2
3
4
{
  "externalReference": "string",
  "observations": "string"
}
Name Type Required Description
externalReference string true none
observations string false none

TesaCreateAccessRequest

-

content_copy
1
2
3
4
5
{
  "externalReference": "string",
  "technicianCode": "string",
  "reason": "string"
}
Name Type Required Description
externalReference string true none
technicianCode string true none
reason string false none

TesaCreateAccessResult

-

content_copy
1
2
3
4
{
  "ctoCheckCode": "string",
  "result": "string"
}
Name Type Required Description
ctoCheckCode string false none
result string false none

TesaCreateStatusCtoRequest

-

content_copy
1
2
3
{
  "externalReference": "string"
}
Name Type Required Description
externalReference string true none

TesaCreatePortRequest

-

content_copy
1
2
3
4
{
  "externalReference": "string",
  "port": "string"
}
Name Type Required Description
externalReference string true none
port string true none

TesaTerminateAccessRequest

-

content_copy
1
2
3
4
{
  "externalReference": "string",
  "observations": "string"
}
Name Type Required Description
externalReference string true none
observations string true none

TesaInstallationIncidentRequest

-

content_copy
1
2
3
4
5
6
7
8
9
{
  "externalReference": "string",
  "requestType": "string",
  "requestNumber": 0,
  "subRequestNumber": 0,
  "incidence": "string",
  "cto": "string",
  "comments": "string"
}
Name Type Required Description
externalReference string true none
requestType string true none
requestNumber integer(int64) true none
subRequestNumber integer(int64) true none
incidence string true none
cto string true none
comments string true none

TesaInstallationEndRequest

-

content_copy
1
2
3
4
5
6
7
8
9
{
  "externalReference": "string",
  "requestType": "NEBA",
  "requestNumber": 0,
  "subRequestNumber": 0,
  "test": "string",
  "indicator": "string",
  "owner": "string"
}
Name Type Required Description
externalReference string true none
requestType string true none
requestNumber integer(int64) true none
subRequestNumber integer(int64) true none
test string true none
indicator string true none
owner string true none
Property Values
requestType one of [NEBA, VULA]

TesaCtoChangeRequest

-

content_copy
1
2
3
4
5
6
{
  "externalReference": "string",
  "ctoIdentifier": "string",
  "ctoPort": "string",
  "reason": "AV"
}
Name Type Required Description
externalReference string true none
ctoIdentifier string true none
ctoPort string false none
reason TesaReasonForCtoChange true Reason for the CTO change:
* AV - Broken
* OT - Others

TesaReasonForCtoChange

-

Name Type Required Description
anonymous string false Reason for the CTO change:
* AV - Broken
* OT - Others
Property Values
anonymous one of [AV, OT]

TesaStatus

-

content_copy
1
"NOT_SENT"
Name Type Required Description
anonymous string false none
Property Values
anonymous one of [NOT_SENT, VALIDATING, REJECTED, PROCESSING, PROCESSED, INCIDENCE_TESA, INCIDENCE_OPERATOR, INSTALLING, INCIDENCE_INSTALLING, INSTALLED, CANCELED, FINISHED]

TesaPersistenceType

-

content_copy
1
"ACTIVATION"
Name Type Required Description
anonymous string false Persistence type:
* ACTIVATION - Activation Request
* TERMINATION - Termination Request
Property Values
anonymous one of [ACTIVATION, TERMINATION]

TesaReferenceIdList

-

content_copy
1
2
3
4
[
  "REQUEST_ID11001",
  "REQUEST_ID11002"
]
None

TesaError

-

content_copy
1
2
3
4
{
  "code": "string",
  "message": "string"
}
Name Type Required Description
code string true none
message string true none

TesaRequest

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
  "reference_id": "EXAMPLE_01_PRUEBA",
  "request_type": "NEB101",
  "persistence_type": "ACTIVATION",
  "territory_owner": "NEBA",
  "tenant": "masmovil",
  "request_number": 2312312,
  "subrequest_number": 1,
  "external_reference": "external_reference",
  "status": "PROCESSING",
  "cancelling": false,
  "portability_indicator": "N",
  "technical_coordinator": {
    "name": "tec_name",
    "surnames": "tec_surnames",
    "principal_phone_number": "612345789",
    "alternative_phone_number": "612345790",
    "email": "email@email.es",
    "alternative_email": "alternative_email@email.es",
    "fax": "612345791"
  },
  "customer_contact": {
    "name": "cus_name",
    "surnames": "cus_surnames",
    "phone_number": "612345792",
    "phone_number_2": "612345793",
    "segment": "B2C"
  },
  "service_point": {
    "gescal": 9827372837277274000,
    "upload_speed": "1M",
    "download_speed": "10M"
  },
  "connection": {
    "connection_test": "S,",
    "connection_reuse_indicator": "S,",
    "connection_owner": "MM,",
    "status": "READY_TO_CONNECTION_STAMPING,",
    "create_date": "2024-05-07T15:13:49Z"
  },
  "connection_data": {
    "iua": "iua,",
    "province_code": "30,",
    "town": "town,",
    "address": "address,",
    "splitter_indicator": "S,",
    "splitter_location": "RE,",
    "splitter_detail": "splitter_detail,",
    "cto_type": "cto_type,",
    "cto_location": "location,",
    "cto_location_detail": "detail,",
    "cto_identifier": "cto_id,",
    "cto_port": 111
  }
}
Name Type Required Description
reference_id string true Operator id reference
request_number integer(int64) false Request code returned by TESA
subrequest_number integer(int64) false Subrequest code returned by TESA
request_type string true Request type e.g NEB101, NBL101
persistence_type TesaPersistenceType true Persistence type:
* ACTIVATION - Activation Request
* TERMINATION - Termination Request
territory_owner string true Territory Owner identifier:
* NEBA - Neba
* VULA_COMMERCIAL - Vula commercial
* VULA_REGULATED - Vula regulated
tenant string true Tenant in lower case
portability TesaPortability false none
technical_coordinator TesaTechnicalCoordinators true none
customer_contact TesaCustomerContact true none
service_point TesaServicePoint true none
status TesaStatus true none
connection TesaConnection false none
connection_data TesaConnectionData false none
cancelling boolean false Whether the request is being cancelled
portability_indicator string false Portability indicator:
* D - Donor
* T - Third party
* N - Without portability
* A - Agreement
external_reference string true External reference
reject_cause string false Reject cause
close_date string(date-time) false Close date
create_date string(date-time) false Create date
update_date string(date-time) false Update date
Property Values
territory_owner one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED]
portability_indicator one of [D, T, N, A]

TesaEvent

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": 1,
  "sequence_number": 1,
  "reference_id": "reference_id",
  "request_number": 0,
  "event_date": "2023-05-31T08:50:40Z",
  "message_type": "message_type",
  "subrequest_number": 6,
  "inconsistent": false
}
Name Type Required Description
id integer(int64) false Event id
reference_id string true Request reference id
message_type string true TESA message type
request_number integer(int64) true TESA request code
subrequest_number integer(int64) true TESA subrequest code returned
event_date string(date-time) true Event date
sequence_number integer(int32) true Sequence Number
inconsistent boolean true If true, the event must be reconciled.

TesaIssue

-

content_copy
1
2
3
4
5
6
7
8
9
{
  "id": 1,
  "reference_id": 1001,
  "issue_sequence": 2,
  "issue_code": "I200",
  "resolved": false,
  "repeated": false,
  "last_updated": "2023-05-31T00:00:00.000Z"
}
Name Type Required Description
id integer(int64) true Id of the issue
reference_id string true Request reference id
issue_sequence integer(int32) true Number of issue
issue_code string true Issue code
resolved boolean true Issue is resolved or not
repeated boolean false Issue is repeated or not
last_updated string(date-time) true The date of the issue

TesaCustomerContact

-

content_copy
1
2
3
4
5
6
7
{
  "phone_number_2": "612345789",
  "name": "name",
  "phone_number": "612345789",
  "surnames": "surnames",
  "segment": "B2C"
}
Name Type Required Description
name string true Contact name
surnames string true Contact Surnames
phone_number string true Contact phone number
phone_number_2 string true Contact phone number 2
segment string true Customer segment
Property Values
segment one of [B2C, B2B, B2B2C]

TesaConnection

-

content_copy
1
2
3
4
5
6
7
{
  "connection_test": "S,",
  "connection_reuse_indicator": "S,",
  "connection_owner": "MM,",
  "status": "READY_TO_CONNECTION_STAMPING,",
  "create_date": "2024-05-07T15:13:49Z"
}
Name Type Required Description
connection_test string false Connection test:
* S - Final test OK
* N - Final test not done or final test not OK
connection_reuse_indicator string false Connection reuse indicator:
* S - Reuse
* N - Not reuse
connection_owner string false Connection owner:
* TE - TELEFÓNICA
* OR - ORANGE / JAZZTEL
* VD - VODAFONE / VODAFONE ONO
* DI - DIGI
* MM - MÁSMÓVIL / GRUPO MM
* EU - EUSKALTEL / R-CABLE
status TesaConnectionStatus true none
close_date string(date-time) false Close date
create_date string(date-time) false Create date

TesaConnectionData

-

content_copy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "iua": "iua,",
  "province_code": "30,",
  "town": "town,",
  "address": "address,",
  "splitter_indicator": "S,",
  "splitter_location": "RE,",
  "splitter_detail": "splitter_detail,",
  "cto_type": "cto_type,",
  "cto_location": "location,",
  "cto_location_detail": "detail,",
  "cto_identifier": "cto_id,",
  "cto_port": 111
}
Name Type Required Description
iua string false Unique access identifier
province_code string false Province code
town string false Town
address string false Town
splitter_indicator string false Splitter indicator:
* S - There is a splitter
* N - There is not a splitter
splitter_location string false Splitter location
splitter_detail string false Splitter detail
cto_type string false CTO type
cto_location string false CTO location
cto_location_detail string false CTO location detail
cto_identifier string false CTO identifier
cto_port integer(int32) false CTO port

TesaConnectionStatus

-

content_copy
1
"READY_TO_CONNECTION_STAMPING"
Name Type Required Description
anonymous string false none
Property Values
anonymous one of [READY_TO_CONNECTION_STAMPING, PROCESSING, INCIDENCE, FINISHED]
Schemas