bango_userinformation

8/4/2019 bango_userinformation

http://slidepdf.com/reader/full/bangouserinformation 1/8

Version 1.2 Page 1 of 8

Integration Guide

User InformationVersion 1.2

November 2007




Contents

CONTENTS .......................................................................................................................................................................2

DOCUMENT CHANGE LOG .........................................................................................................................................3

INTRODUCTION ..............................................................................................................................................................4

WEB SERVICES API ......................................................................................................................................................5

S ECURITY ........................................................................................................................................................................5 WSDL LOCATION ...........................................................................................................................................................5 REQUESTING WEB S ERVICES ACCESS ...........................................................................................................................5 WEB METHODS ...............................................................................................................................................................6

GetMobileNumber ....................................................................................................................................................6

GetUserId ..................................................................................................................................................................7 MarketingOptOut ......................................................................................................................................................8




Document change log

Date Version Change detail20 June 2007 1.0 Published03 October 2007 1.1 MarketingOptOut method added

GetMobileNumber responses extended23 November 2007 1.2 GetMobileNumber response OPERATOR_REFUSED replaced with

OPERATOR_REJECTED




Introduction

The Bango User Information service allows you to securely find out useful information relating to usersregistered in the Bango platform, for example a user’s mobile phone number for marketing or supportpurposes.

The User Information service is likely to be expanded so please refer to the latest version of this document.

User information supports the following scenarios:

• You have the user MSISDN and want to match it to the Bango Fingerprint• You have the Bango Fingerprint and want to match it to the user’s MSISDN for agreed reasons. For

example marketing or customer care purposes. • You wish to inform Bango that a user has opted out of your service.




Web Services API

The Web Services API is a secure server-to-server API allowing access to the details of users held within theBango system.

Security

The Web Services API is protected to ensure that only authorized clients use it. There are three primarylevels of security:

• API username / password and third-party account authentication• Client IP address validation• Secure Sockets Layer (SSL) data transport

A failure at any one of these security levels denies access to the Web Services API.

The Web Services API allows your server to send requests to the Bango server. The Bango server will onlyaccept requests from authorized IP addresses.

Requests directly from an on-handset application are not allowed – the application must communicate withyour server, which must then communicate with the Bango Web Services API.

WSDL Location

The User Information WSDL can be located at the following URL:

https://webservices.bango.com/userinformation/?wsdl

Requesting Web Services access

Before you can use the Web Services API, you need to first request access credentials from Customer Services via [email protected] .

Access to the API is dependant upon package level. If you are unsure whether the API is available to you

please contact Customer Services.




Web Methods

Method: GetMobileNumber

Description: Returns a user’s mobile phone number (MSISDN).

A request for a user’s mobile phone number must be accompanied with a purpose as operator policies on providing the number do vary.

You must only use the mobile phone number for the purpose stated.

For example, if you request the mobile phone number for SUPPORT you cannot then go on

and use the same number for MARKETING.Inputs: username Your username

password Your passworduserId User IDbango Bango Number purpose Why the phone number is required - one of:

SUPPORTDELIVERYMARKETINGPARTNERMARKETING

Outputs: responseCode Status of request. Indication of whether the user’s mobilenumber can be used for the requested purpose.responseMessage Textual description of request statususageCondition Free-text description of any operator conditions associated

with using the mobile number for the requested purposemobileNumber User’s mobile number (or empty string if not released)

ResponseCodes:

OK SuccessACCESS_DENIED Invalid username/passwordACCESS_DENIED Invalid IP addressACCESS_DENIED Invalid access to specified Bango number INVALID_BANGO Invalid Bango number INVALID_USERID Invalid user ID

INVALID_PURPOSE Invalid purpose codeINTERNAL_ERROR A problem on the server meant that the request could not

be processedOPERATOR_UNKNOWN Operator not known for this user OPERATOR_REJECTED Operator will not release MSISDNNO_MOBILE_NUMBER Mobile number not known for this user USER_NOT_OPTED_IN User has not yet opted into marketingUSER_OPTED_OUT User has explicitly opted out of marketingUSER_OPTIN_EXPIRED User opt-in has expired; i.e. greater than 6 months old




Method: GetUserIdDescription: Returns the user id (Fingerprint) for a mobile phone number on a specific operator.

If the user is already known to the Bango system, their user id will be returned.

If the user is not known, but is on an operator which passes real-time MSISDNs to Bango, anew user account is automatically created and the user id returned. When the user doesaccess the Bango system and their MSISDN is passed to Bango by their operator, this is theuser id they will be assigned.

Inputs: username Your usernamepassword Your password

userId User IDmobileNumber The mobile number to search for – must be international

format i.e. 16141234567 or 447787123456networkId Bango operator id (see Relay documentation for list)bango A Bango Number accessible by these credentials

Outputs: responseCode Status of request.responseMessage Textual description of request statususerId User id for this mobile number

ResponseCodes:

OK SuccessACCESS_DENIED Invalid username/passwordACCESS_DENIED Invalid IP addressACCESS_DENIED Invalid access to specified Bango number INVALID_BANGO Invalid Bango number INTERNAL_ERROR A problem on the server meant that the request could not

be processedNOT_FOUND Matching user id not found (and cannot be created)




Method: MarketingOptOutDescription: Notifies Bango a user has opted out of your service.

A request for opting out a user must be accompanied with a Bango Number belonging to your service.

Inputs: username Your usernamepassword Your passworduserId User IDbango A Bango Number accessible by these credentials

Outputs: responseCode Status of request.

responseMessage Textual description of request status

ResponseCodes:

OK SuccessACCESS_DENIED Invalid username/passwordACCESS_DENIED Invalid IP addressACCESS_DENIED Invalid access to specified Bango number INVALID_BANGO Invalid Bango number INTERNAL_ERROR A problem on the server meant that the request could not

be processed

Documents

bango_userinformation