Open APIs

Hi all , 

I am working on use cases for the mobile line product: 1) retrieving claims from CRM, and 2) creating a claim in CRM. If the CRM uses MSISDN (phone number) to retrieve and create tickets, how should I specify this MSISDN in the header (filters) and in the API body?

Many thanks 

Hello Imene,

That depends on where you store the MSISDN. Let's assume you are storing it in the 'externalId' field of the ticket. in that case, the query should look like this:

GET /tmf-api/troubleTicket/v4/troubleTicket?externalId={your_msisdn}

This will return a list of tickets whose external ID matches the provided MSISDN. You can refine the search further by adding additional parameters if needed. For example:

GET /tmf-api/troubleTicket/v4/troubleTicket?externalId={your_msisdn}&status=pending

In any case, I recommend reviewing the TMF630 REST API Design Guidelines 4.2.0 document, which provides detailed guidance on the design principles applied to all TM Forum APIs.

Best regards,

Abel

Hi Imene

Within TMF621 Trouble Ticket API V5, there is a characteristic pattern (see below).  You could add the MSISDN/Number as a characteristic and then use a JSON Path filter as described in TMF630 Design Guidelines Part 6.  Alternatively, you could add a relatedEntity to the LogicalResource (MSISDN) and query based on the relatedEntity.id