TNID
  • Welcome
  • Getting Started
    • Company Authentication
    • User Authentication
    • Accessing via Postman / GraphQL Schema examples
  • Company
    • Search Companies
    • Invite Company
    • List Organization Types
    • List Vertical Types
    • Update Company Profile
    • B2B Features
      • Send B2B Connection Request
      • List B2B Connections
      • List Pending B2B Connection Requests
      • Cancel B2B Connection Request
      • Get Received B2B Connection Requests
      • Respond to B2B Connection Requests
    • B2C Features
      • List B2C (People) Connections
      • List Pending People Connection Requests
      • List Active Subscribers
      • List Pending Subscription Requests
      • Send Person (B2C) Connection Request
      • Invite People (as Company)
      • Send Person (B2C) Subscription Request
      • Cancel Pending B2C Connection Request
      • Cancel Pending B2C Subscription Request
      • Get Pending Connection Requests (People)
      • Respond to C2B Connection Request
      • Get Connected People
      • Search People
      • List Opt-Out Requests
      • Create Opt-out Request
  • User
    • Update User profile
    • Search User (People)
    • Invite User (People)
    • Connections
      • Send C2B Connection Request
      • List B2C connections
      • List received pending B2C Connection Requests
      • Respond to received B2C Connection Request
      • Revoke sent C2B Connection Request
      • List sent pending C2B Connection Requests
    • Spam Reporting Features
      • Create Spam Report
      • List Spam Reports
    • Company Features
      • Search Companies
      • Create company profile
      • List Pending C2C Connection Requests
      • Revoke sent C2C Connection Request
      • List Received C2C Connection Requests
      • Send C2C Connection Request
      • Respond C2C Connection Request
      • List C2C Connections
  • Group Features
    • Search Groups
    • List User's Groups
    • Create Group
    • Update group
    • Invite User to Group
    • Respond to Group invite
    • List pending Group invites (Sent)
    • List pending Group invites (Received)
    • Revoke Pending Group User Member Invite
    • Send Group user member join request
    • List Received Pending Group user member join request
    • List Pending Group user member join request
    • Revoke Group user member join request
    • Respond to Group user member join request
Powered by GitBook
On this page

Was this helpful?

  1. User
  2. Spam Reporting Features

Create Spam Report

Use this endpoint to create a spam report.

The User GraphQL API is accessible at /user

  mutation (
	$fromNumber: String!
	$toNumber: String!
	$channelType: SpamReportChannelType!
	$timestamp: NaiveDateTime!
	$issueType: SpamReportIssueType
	$userNote: String
	$messageContent: String
	$metadata: Json
  ) {
	createSpamReport (
  	fromNumber: $fromNumber
  	toNumber: $toNumber
  	channelType: $channelType
  	timestamp: $timestamp
  	issueType: $issueType
  	userNote: $userNote
  	messageContent: $messageContent
  	metadata: $metadata
	) {
  	id
  	fromNumber
  	toNumber
  	userNote
  	messageContent
  	channelType
  	issueType
  	status
  	createdAt
  	updatedAt
  	timestamp
  	metadata
  	user {
    	id
  	}
	}
  }

Example Code

from datetime import datetime

import aiohttp
from gql import gql, Client
from gql.transport.aiohttp import AIOHTTPTransport

# courtesy of https://github.com/PockyBum522/
# Please note that this basic example won't work if you have an asyncio event loop running.
# In some python environments (as with Jupyter which uses IPython) an asyncio event loop is created for you.
# In that case you should use instead https://gql.readthedocs.io/en/latest/async/async_usage.html#async-usage
def user_create_spam_report(bearer_token, from_number = None, to_number = None, channel_type = None, timestamp = None, issue_type = None, user_note = None, message_content = None, metadata = None):
    transport = AIOHTTPTransport(
        url="https://api.staging.v2.tnid.com/user",
        headers=
        {
            "Authorization": f"Bearer {bearer_token}"
        }
    )

    # Create a GraphQL client using the defined transport
    client = Client(transport=transport, fetch_schema_from_transport=True)

    query = gql(
            """
              mutation (
                $fromNumber: String!
                $toNumber: String!
                $channelType: SpamReportChannelType!
                $timestamp: NaiveDateTime!
                $issueType: SpamReportIssueType
                $userNote: String
                $messageContent: String
                $metadata: Json
              ) {
                createSpamReport (
                fromNumber: $fromNumber
                toNumber: $toNumber
                channelType: $channelType
                timestamp: $timestamp
                issueType: $issueType
                userNote: $userNote
                messageContent: $messageContent
                metadata: $metadata
                ) {
                id
                fromNumber
                toNumber
                userNote
                messageContent
                channelType
                issueType
                status
                createdAt
                updatedAt
                timestamp
                metadata
                user {
                    id
                }
                }
              }
            """
    )

    params = { "fromNumber": from_number,
               "toNumber": to_number,
               "channelType": channel_type,
               "timestamp": timestamp,
               "issueType": issue_type,
               "userNote": user_note,
               "messageContent": message_content,
               "metadata": metadata }

    try:
        # Execute the query on the transport
        response = client.execute(query, params)
        print(f"Response OK: {response}")
        return response
    except Exception as e:
        print(f"Exception: {e}")


# Example usage:
token = "your_user_token"
user_create_spam_report(token,
                        "15555555555",
                        "16666666666",
                        "MMS",
                        "2023-10-31 11:30:00",
                        "SPAM",
                        "Note about the report",
                        "Original message content",
                        "{ \"customField\": \"custom value\" }" )

PreviousSpam Reporting FeaturesNextList Spam Reports

Last updated 7 months ago

Was this helpful?