{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Consume ntm-message-service","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"consume-ntm-message-service","__idx":0},"children":["Consume ntm-message-service"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ntm-message-service-can-be-used-to","__idx":1},"children":["NTM Message Service can be used to:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Publish a message to one's own channel"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send a message to one's own application users"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send a message to a specific user"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve messages of a specific user"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve messages of a specific application"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve scheduled messages which are active"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For detailed information on each parameter in the request body, refer NTM Message Definition"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Requests"]},":"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,153,0)"}},"children":[" POST:"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["/message"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Message ID will be generated after making a POST request. The following sample cURL is a message cURL destined to two users \"abc@slb.com\" and \"def@slb.com\""]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample cUrl"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Output"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["curl -X POST \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    'https://api.delfi.slb.com/ntm/v1/message' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Authorization: Bearer <",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,0,0)"}},"children":["your-ccg-token"]},">' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'AppKey: <",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,0,0)"}},"children":["your-appkey"]},">'\\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Cache-Control: no-cache' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Content-Type: application/json' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -d '{ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"sourceUserId\": \"\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"sourceAppTag\": \"\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageMediaType\": \"\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageTitle\": \"New Contract\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageText\": \"NTM created a new contract\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageSendAt\": \"\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageExpiresAt\": \"\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"destinationUserId\": [ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"          \"abc@slb.com\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"          \"def@slb.com\" ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      ], ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"context\": { ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"          \"account\": \"Account A\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"          \"contract\": \"Contract C\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"          \"department\": \"Department D\" ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"        } ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      }'"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    \"Message\": \"493dad1c-6082-4bb5-8e3a-2611cd847754\" ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," }"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,153,0)"}},"children":[" GET:"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["/message/application"]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample cUrl"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Output"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["curl -X GET \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    'https://api.delfi.slb.com/ntm/v2/message/application' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Authorization: Bearer <",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,0,0)"}},"children":["your-ccg-token"]},">' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'AppKey: <",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,0,0)"}},"children":["your-appkey"]},">'\\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Cache-Control: no-cache' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    { ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"contextAccount\": \"Account A\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"contextContract\": \"Contract C\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"contextDepartment\": \"Department D\",  ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"destinationUserId\": \"\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"destinationAppId\": \"ntm-master-svc-ntm.slbservice.com\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageId\": \"15601d8d-74f2-4750-b998-56cf6108c75c\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageText\": \"\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageTimestamp\": \"2018-08-13 17:08:30.417052351 +0000 UTC\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageTitle\": \"New Contract\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"sourceAppId\": \"ntm-master-svc-ntm.slbservice.com\" ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    } ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ]"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,153,0)"}},"children":[" GET:"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["/message/user"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following sample cURL is a message cURL destined to a single user \"def@slb.com\""]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample cUrl"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Output"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["curl -X GET \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    'https://api.delfi.slb.com/ntm/v2/message/user' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Authorization: Bearer <",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,0,0)"}},"children":["your-user-exchange-token"]},">' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'AppKey: <",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,0,0)"}},"children":["your-appkey"]},">' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Cache-Control: no-cache' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Postman-Token: 645076e9-2132-49e0-ac4f-71138ba219e6' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    { ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"contextAccount\": \"Account A\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"contextContract\": \"Contract C\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"contextDepartment\": \"Department D\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"destinationUserId\": \"def@slb.com\",  ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"destinationAppId\": \"ntm-master-svc-ntm.slbservice.com\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageId\": \"15601d8d-74f2-4750-b998-56cf6108c75c\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageText\": \"\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageTimestamp\": \"2018-08-13 17:08:30.417052351 +0000 UTC\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"messageTitle\": \"New Contract\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      \"sourceAppId\": \"ntm-master-svc-ntm.slbservice.com\" ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    } ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ]"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,153,0)"}},"children":[" GET:"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["/message/schedule"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following sample cURL is used to retrieve scheduled messages by active status."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample cUrl"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Output"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["curl -X GET \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    'https://api.delfi.slb.com/ntm/v1/message/schedule' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Authorization: Bearer <",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,0,0)"}},"children":["your-CCG-token"]},">' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'AppKey: <",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"rgb(255,0,0)"}},"children":["your-appkey"]},">' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Cache-Control: no-cache' \\ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    -H 'Postman-Token: 645076e9-2132-49e0-ac4f-71138ba219e6' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{\"pageCursor\": \"eyJMaW1pdCI6NTAsIlBhZ2UiOjIsIk9yZGVyQnkiOiItQ3JlYXRlZEF0In0\", ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," \"scheduledMessages\" : \"[ ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    { ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      “contextAccount”: “Account A”, ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      “contextContract”: “Contract C”, ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      “contextDepartment”: “Department D”, ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      “originMessageId”: “2ebc852b-dca3-4910-9374-a2ee83a1c670”, ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      “messageText”: “”, ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      “messageTimestamp”: “2018-08-13 17:08:30.417052351 +0000 UTC”, ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      “messageTitle”: “New Contract”, ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"      “messageSendAt”: \"2024-04-09 00:00:00 +0000 UTC\" ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"    } ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ]\"}"]}]}]}]}]}]},"headings":[{"value":"Consume ntm-message-service","id":"consume-ntm-message-service","depth":3},{"value":"NTM Message Service can be used to:","id":"ntm-message-service-can-be-used-to","depth":4}],"frontmatter":{"seo":{"title":"Consume ntm-message-service"}},"lastModified":"2025-11-07T15:44:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/ntm/tutorial/ntm-consume-message-service","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}