APIHubSandbox
API for the API Telco TLV.APIHub
| Sandbox Case Number | Sandbox Case Description | Sandbox Values | JSON Request Example |
|---|---|---|---|
| 1 | The final user/customer phone number is VALID with phone carrier TELCEL, phone type MOBILE. The ownership and socialNetoworks are not requested. |
phoneNumber: 5500000001 ownership: false socialNetworks: false | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","customer": {"phoneNumber": "5500000001","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": false,"socialNetworks": false,"statistics": false}} |
| 2 | The final user/customer phone number is VALID with phone carrier AT&T, phone type MOBILE. The ownership and socialNetoworks are not requested. | phoneNumber: 5500000002 ownership: false socialNetworks: false | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","customer": {"phoneNumber": "5500000002","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": false,"socialNetworks": false,"statistics": false}} |
| 3 | The final user/customer phone number is VALID with phone carrier TOTAL PLAY, phone type LANDLINE. The ownership and socialNetoworks are not requested. | phoneNumber: 5500000003 ownership: false socialNetworks: false | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","customer": {"phoneNumber": "5500000003","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": false,"socialNetworks": false,"statistics": false}} |
| 4 | The final user/customer phone number is INVALID. The ownership and socialNetoworks are not requested. | phoneNumber: 5500000004 ownership: false socialNetworks: false | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","customer": {"phoneNumber": "5500000004","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": false,"socialNetworks": false,"statistics": false}} |
| 5 |
The final user/customer phone number is VALID with phone carrier TELCEL, phone type MOBILE. The ownership is requested and socialNetoworks is not. The simulation message response of the final user/customer confirms the ownership of the phone number. | phoneNumber: 5500000001 ownership: true socialNetworks: false | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","termsConditionsUrl": "https://www.test.com/terms-conditions","customer": {"phoneNumber": "5500000001","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": true,"socialNetworks": false,"statistics": false}} |
| 6 |
The final user/customer phone number is VALID with phone carrier AT&T, phone type MOBILE. The ownership is requested and socialNetoworks is not. The simulation message response of the final user/customer denies the ownership of the phone number. |
phoneNumber: 5500000002 ownership: true socialNetworks: false | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","termsConditionsUrl": "https://www.test.com/terms-conditions","customer": {"phoneNumber": "5500000002","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": true,"socialNetworks": false,"statistics": false}} |
| 7 |
The final user/customer phone number is VALID with phone carrier TOTAL PLAY, phone type LANDLINE. The ownership is requested and socialNetoworks is not. The message ownership process of the aggregation cannot be done since is a LANDLINE phone number. The ownership status will be marked as FAILED. |
phoneNumber: 5500000003 ownership: true socialNetworks: false | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","termsConditionsUrl": "https://www.test.com/terms-conditions","customer": {"phoneNumber": "5500000003","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": true,"socialNetworks": false,"statistics": false}} |
| 8 | The final user/customer phone number is INVALID. The ownership is requested and socialNetoworks is not. | phoneNumber: 5500000004 ownership: true socialNetworks: false |
{"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","termsConditionsUrl": "https://www.test.com/terms-conditions","customer": {"phoneNumber": "5500000004","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": true,"socialNetworks": false,"statistics": false}} |
| 9 |
The final user/customer phone number is VALID with phone carrier TELCEL, phone type MOBILE. The ownership is not requested and socialNetoworks is. The simulation result of the socialNetworks is true for all social-networks. | phoneNumber: 5500000001 ownership: false socialNetworks: true |
{"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","customer": {"phoneNumber": "5500000001","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": false,"socialNetworks": true,"statistics": false}} |
| 10 |
The final user/customer phone number is VALID with phone carrier AT&T, phone type MOBILE. The ownership is not requested and socialNetoworks is. The simulation result of the socialNetworks is true for all social-networks. | phoneNumber: 5500000002 ownership: false socialNetworks: true |
{"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","customer": {"phoneNumber": "5500000002","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": false,"socialNetworks": true,"statistics": false}} |
| 11 |
The final user/customer phone number is VALID with phone carrier TOTAL PLAY, phone type LANDLINE. The ownership is not requested and socialNetoworks is. The socialNetwork process of the aggregation cannot be done since is a LANDLINE phone number. No data will be returned for the socialNetworks. | phoneNumber: 5500000003 ownership: false socialNetworks: true |
{"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","customer": {"phoneNumber": "5500000003","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": false,"socialNetworks": true,"statistics": false}} |
| 12 | The final user/customer phone number is INVALID. The ownership is not requested and socialNetoworks is. | phoneNumber: 5500000004 ownership: false socialNetworks: true |
{"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","customer": {"phoneNumber": "5500000004","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": false,"socialNetworks": true,"statistics": false}} |
| 13 |
The final user/customer phone number is VALID with phone carrier TELCEL, phone type MOBILE. The ownership and socialNetoworks are requested. The simulation message response of the final user/customer confirms the ownership of the phone number. The simulation result of the socialNetworks is true for all social-networks. | phoneNumber: 5500000001 ownership: true socialNetworks: true | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","termsConditionsUrl": "https://www.test.com/terms-conditions","customer": {"phoneNumber": "5500000001","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": true,"socialNetworks": true,"statistics": false}} |
| 14 |
The final user/customer phone number is VALID with phone carrier AT&T, phone type MOBILE. The ownership and socialNetoworks are requested. The simulation message response of the final user/customer denies the ownership of the phone number. The simulation result of the socialNetworks is true for all social-networks. | phoneNumber: 5500000002 ownership: true socialNetworks: true | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","termsConditionsUrl": "https://www.test.com/terms-conditions","customer": {"phoneNumber": "5500000002","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": true,"socialNetworks": true,"statistics": false}} |
| 15 |
The final user/customer phone number is VALID with phone carrier TOTAL PLAY, phone type LANDLINE. The ownership and socialNetoworks are requested. The message ownership process of the aggregation cannot be done since is a LANDLINE phone number. The ownership status will be marked as FAILED. The socialNetwork process of the aggregation cannot be done since is a LANDLINE phone number. No data will be returned for the socialNetworks. | phoneNumber: 5500000003 ownership: true socialNetworks: true |
{"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","termsConditionsUrl": "https://www.test.com/terms-conditions","customer": {"phoneNumber": "5500000003","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": true,"socialNetworks": true,"statistics": false}} |
| 16 | The final user/customer phone number is INVALID. The ownership and socialNetoworks are requested. | phoneNumber: 5500000004 ownership: true socialNetworks: true | {"requestId": "c020d499-11fb-1b8a-a36b-00b0d063b220","subscriptionId": "87d4e983-8498-439c-a9b1-c91dceac8cab","companyName": "Company Demo","termsConditionsUrl": "https://www.test.com/terms-conditions","customer": {"phoneNumber": "5500000004","name": "Juan Pruebas","authorization": true,"authorizationDateTime": "2023-08-09T17:40:28.372Z"},"settings": {"ownership": true,"socialNetworks": true,"statistics": false}} |
IMPORTANT: This value MUST be an UUID v1. This ensures efficient system performance.
subscriptionId: type: string format: uuid description: >- The unique identifier of a valid 'Círculo de Crédito' subscription.This value allows the asynchronous reception of the results of this API, through an HTTP call to the webhook associated with the subscription.
companyName: type: string pattern: >- ^[a-zA-ZñÑáéíóúÁÉÍÓÚ]+(([ ][a-zA-ZñÑáéíóúÁÉÍÓÚ ])?[a-zA-ZñÑáéíóúÁÉÍÓÚ]*)*$ example: Pruebas Corportation description: >- The name of the 'business/company' that is trying to validate the phone number via 'whatsapp' message.IMPORTANT: This name will appear in the whatsapp message sent to the final user.
NOTE: This field only works if the 'setting' 'ownership' is activated (true).
termsConditionsUrl: type: string description: >- The company terms and conditions URL. This URL is shown in the whatsapp validation message that is send to the end-user.IMPORTANT: This value MUST be an UUID v1. This ensures efficient system performance.
inquiryId: type: string format: uuid description: >- The unique identifer of the Telco Aggregation, allows to track the progress and final result of the aggregation.IMPORTANT: This is NOT an UUID string, is an alphanumeric string with hyphen characters, with variable length from 37 characters up to 64 characters.
NOTE: This value is automatically generated by the API Telco ONLY when there is a successful aggregation request.
dateTime: type: string format: date-time description: >- The date-time when the Telco Aggregation was STARTED, NOT_AUTHORIZED or FAILED. status: type: string enum: - STARTED - NOT_AUTHORIZED - FAILED description: >- The possible 'status' values that the Telco Aggregation can have when it is requested. AggregationPhoneNumberGetResponse: type: object properties: requestId: type: string format: uuid description: >- The unique identifier of the request, this value is provided by the client consuming the API.IMPORTANT: This value MUST be an UUID v1. This ensures efficient system performance.
inquiryId: type: string format: uuid description: >- The unique identifer of the Telco Aggregation, allows to track the progress and final result of the aggregation.IMPORTANT: This is NOT an UUID string, is an alphanumeric string with hyphen characters, with variable length from 37 characters up to 64 characters.
NOTE: This value is automatically generated by the API Telco ONLY when there is a successful aggregation request.
status: type: string enum: - FINISHED - IN_PROGRESS - FAILED - NOT_AUTHORIZED description: >- The possible 'status' values that the Telco Aggregation can have when it is queried. dateTime: type: string format: date-time description: >- The date-time when the Telco Aggregation was FINISHED, IN_PROGRESS, NOT_AUTHORIZED or FAILED. aggregation: $ref: '#/definitions/Aggregation' Customer: type: object properties: phoneNumber: type: string pattern: ^[0-9]{10}$ description: The phone number that will be used for the Telco Aggregation process. name: type: string pattern: >- ^[a-zA-ZñÑáéíóúÁÉÍÓÚ]+(([ ][a-zA-ZñÑáéíóúÁÉÍÓÚ ])?[a-zA-ZñÑáéíóúÁÉÍÓÚ]*)*$ example: Juan Pruebas description: >- The name of the final user/customer which phone number will be validated via 'whatsapp' message.IMPORTANT: This name will appear in the whatsapp message sent to the final user.
NOTE: This field only works if the 'setting' 'ownership' is activated (true).
authorization: type: boolean description: >- A boolean flag to indicate the authorization of the final user/customer to do the Telco Aggregation process with their phone number. True if the final user/customer authorize the Telco Aggregation process, false otherwise.IMPORTANT: If the final user/customer do not authorize the Telco Aggregation process the process will not be carried out and will be cancelled.
authorizationDateTime: type: string format: date-time description: >- The date-time when the final user/customer authorized the Telco Aggregation process on their own phone number. AggregationSettings: type: object description: >- Settings available in the API Telco, allows you to choose the behavior that the API will have. properties: ownership: type: boolean description: Activates the phone message validation via 'whatsapp' message. socialNetworks: type: boolean description: >- Activates the validation of social networks associated with the phone number. statistics: type: boolean description: Reserved for future use. Not working right now. Aggregation: type: object properties: phone: $ref: '#/definitions/Phone' socialNetworks: $ref: '#/definitions/SocialNetworks' Phone: type: object properties: number: type: string pattern: ^[0-9]{10}$ description: The phone number used for the Telco Aggregation process. carrier: type: string example: TELCEL description: The phone carrier of the phone number. city: type: string example: CUAUHTEMOC description: The city associated with phone number. type: type: string enum: - MOBILE - LANDLINE description: The type of phone number. authenticity: type: string enum: - VALID - INVALID - UNKNOWN description: Indicates the validity of the telephone number. ownership: type: string enum: - WAITING_CONFIRMATION - NOT_REQUESTED - OWNERSHIP_CONFIRMED - OWNERSHIP_DENIED - NOT_CONFIRMED - FAILED description: >- Indicates the current 'status' of the 'ownership' process (i.e. the whatsapp message validation) in the Telco Aggregation. SocialNetworks: type: object description: >- Indicates the social networks associated with the provided phone number. True if the social network is associated with phone number, false otherwise properties: whatsapp: type: boolean facebook: type: boolean instagram: type: boolean google: type: boolean twitter: type: boolean microsoft: type: boolean yahoo: type: boolean skype: type: boolean snapchat: type: boolean telegram: type: boolean ResponseErrorObject: type: object properties: errors: type: array items: $ref: '#/definitions/ArrayErrorObject' ArrayErrorObject: type: object properties: code: type: string message: type: string