Testing Your Invoke Service Integration

You can test Invoke Service requests against our Customer Integration Environment (CIE). The CIE enables you to integrate with OpenMarket web services in a controlled, test environment. Using the CIE you can test your applications against various conditions that might occur in production without actually performing live transactions with end users or mobile operators. You can use the same details in the CIE that you intend to use in production.

What you can test

The CIE provides a fully functional API experience. It performs the same validation and processing logic on each transaction as it will in production.

Constraints to be aware of when using the CIE

This testing will not invoke a service. Therefore, once you have tested the API integration with the CIE, you will then need to test invoking your production service using your test mobile handsets.

You cannot use the CIE for performance or load testing. The CIE is also not geo-redundant or highly available.

Connecting to the CIE

The CIE endpoint (with mandatory serviceId parameter) is:


To use the test environment, you will need the same permissions in your customer account that are required when connecting to the production environment. See Making Invoke Service Requests.

Testing scenarios

This table represents some common error scenarios that could occur.

To test...

Enter these details...

Response code


A successful request

Send a valid request. You can use any mobile number for the end user.

HTTP 202

Send the requests as you would in the production environment. As long as you don't create any situation that would deliver back an error, the transactions will all be successful.

The request ID is included in the header. There is no response body.

Bad request response from OpenMarket

Send a bad request. An example is a malformed element in the JSON (e.g. phnNumber rather than phoneNumber).

HTTP 400 with response code 12002

OpenMarket validates all the JSON properties. For example, this includes checking that each scope object (e.g. "request") appears no more than once.

Not specifying a service ID

Send the request without a service ID in the URL.

HTTP 404 with response code 12006


Incorrect account details provided

Enter invalid credentials in the request header.

HTTP 401 with response code 12009


Account not able to use this API

Use an account that does not have the proper authorization in place, such as an account without the Services Manager, User or Viewer role provisioned. For more information see Enabling your account.

HTTP 403 with response code 12001