ऐप्लिकेशन सर्वर को भेजने के अनुरोध बनाएं

Firebase एडमिन SDK टूल या FCM ऐप्लिकेशन सर्वर प्रोटोकॉल का इस्तेमाल करके, मैसेज के अनुरोध बनाए जा सकते हैं और उन्हें इस तरह के टारगेट पर भेजा जा सकता है:

  • विषय का नाम
  • स्थिति
  • डिवाइस रजिस्ट्रेशन टोकन
  • डिवाइस ग्रुप का नाम (सिर्फ़ प्रोटोकॉल के लिए)

पहले से तय फ़ील्ड से बने सूचना पेलोड, उपयोगकर्ता के तय किए गए फ़ील्ड का डेटा पेलोड या दोनों तरह के पेलोड वाले मैसेज भेजे जा सकते हैं. ज़्यादा जानकारी के लिए मैसेज के टाइप देखें.

इस पेज में दिए गए उदाहरणों में बताया गया है कि Firebase एडमिन SDK टूल (जो नोड, Java, Python, C#, और Go) और v1 एचटीटीपी प्रोटोकॉल के लिए काम करता है. बंद किए गए लेगसी एचटीटीपी और XMPP प्रोटोकॉल के ज़रिए, मैसेज भेजने के लिए भी दिशा-निर्देश दिए गए हैं.

चुनिंदा डिवाइसों पर मैसेज भेजें

किसी एक डिवाइस पर ईमेल भेजने के लिए, डिवाइस का रजिस्ट्रेशन टोकन पास करें, जैसा कि यहां दिखाया गया है. रजिस्ट्रेशन टोकन के बारे में ज़्यादा जानने के लिए, अपने प्लैटफ़ॉर्म के लिए क्लाइंट सेटअप करने की जानकारी देखें.

Node.js के लिए

// This registration token comes from the client FCM SDKs.
const registrationToken = 'YOUR_REGISTRATION_TOKEN';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  token: registrationToken
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Java

// This registration token comes from the client FCM SDKs.
String registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setToken(registrationToken)
    .build();

// Send a message to the device corresponding to the provided
// registration token.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);

Python

# This registration token comes from the client FCM SDKs.
registration_token = 'YOUR_REGISTRATION_TOKEN'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    token=registration_token,
)

# Send a message to the device corresponding to the provided
# registration token.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)

शुरू करें

// Obtain a messaging.Client from the App.
ctx := context.Background()
client, err := app.Messaging(ctx)
if err != nil {
	log.Fatalf("error getting Messaging client: %v\n", err)
}

// This registration token comes from the client FCM SDKs.
registrationToken := "YOUR_REGISTRATION_TOKEN"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Token: registrationToken,
}

// Send a message to the device corresponding to the provided
// registration token.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)

C#

// This registration token comes from the client FCM SDKs.
var registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Token = registrationToken,
};

// Send a message to the device corresponding to the provided
// registration token.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}

cURL निर्देश:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "notification":{
     "title":"FCM Message",
     "body":"This is an FCM Message"
   },
   "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

सफल होने पर, मैसेज भेजने का हर तरीका एक मैसेज आईडी दिखाता है. Firebase एडमिन SDK, projects/{project_id}/messages/{message_id} फ़ॉर्मैट में आईडी स्ट्रिंग दिखाता है. एचटीटीपी प्रोटोकॉल रिस्पॉन्स एक JSON कुंजी है:

    {
      "name":"projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c96"
    }

एक से ज़्यादा डिवाइसों पर मैसेज भेजना

एडमिन FCM एपीआई आपको डिवाइस रजिस्ट्रेशन टोकन की सूची पर मैसेज को मल्टीकास्ट करने देते हैं. हर बार शुरू करने पर, ज़्यादा से ज़्यादा 500 डिवाइस रजिस्ट्रेशन टोकन तय किए जा सकते हैं.

Node.js के लिए

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

Java

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");

Python

# Create a list containing up to 500 registration tokens.
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))

शुरू करें

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)

C#

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");

रिटर्न वैल्यू, टोकन की ऐसी सूची होती है जो इनपुट टोकन के क्रम के मुताबिक होती है. यह तब काम आता है, जब आपको यह पता करना हो कि किन टोकन की वजह से गड़बड़ियां हुई हैं.

Node.js के लिए

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    if (response.failureCount > 0) {
      const failedTokens = [];
      response.responses.forEach((resp, idx) => {
        if (!resp.success) {
          failedTokens.push(registrationTokens[idx]);
        }
      });
      console.log('List of tokens that caused failures: ' + failedTokens);
    }
  });

Java

// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
if (response.getFailureCount() > 0) {
  List<SendResponse> responses = response.getResponses();
  List<String> failedTokens = new ArrayList<>();
  for (int i = 0; i < responses.size(); i++) {
    if (!responses.get(i).isSuccessful()) {
      // The order of responses corresponds to the order of the registration tokens.
      failedTokens.add(registrationTokens.get(i));
    }
  }

  System.out.println("List of tokens that caused failures: " + failedTokens);
}

Python

# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
if response.failure_count > 0:
    responses = response.responses
    failed_tokens = []
    for idx, resp in enumerate(responses):
        if not resp.success:
            # The order of responses corresponds to the order of the registration tokens.
            failed_tokens.append(registration_tokens[idx])
    print('List of tokens that caused failures: {0}'.format(failed_tokens))

शुरू करें

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

if br.FailureCount > 0 {
	var failedTokens []string
	for idx, resp := range br.Responses {
		if !resp.Success {
			// The order of responses corresponds to the order of the registration tokens.
			failedTokens = append(failedTokens, registrationTokens[idx])
		}
	}

	fmt.Printf("List of tokens that caused failures: %v\n", failedTokens)
}

C#

// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
if (response.FailureCount > 0)
{
    var failedTokens = new List<string>();
    for (var i = 0; i < response.Responses.Count; i++)
    {
        if (!response.Responses[i].IsSuccess)
        {
            // The order of responses corresponds to the order of the registration tokens.
            failedTokens.Add(registrationTokens[i]);
        }
    }

    Console.WriteLine($"List of tokens that caused failures: {failedTokens}");
}

विषयों के लिए मैसेज भेजें

विषय बनाने के बाद, क्लाइंट-साइड पर विषय के लिए क्लाइंट ऐप्लिकेशन इंस्टेंस की सदस्यता लेकर या सर्वर एपीआई की मदद से, उस विषय पर मैसेज भेजे जा सकते हैं. अगर आप पहली बार FCM के लिए अनुरोध भेज रहे हैं, तो बैकग्राउंड और सेटअप की ज़रूरी जानकारी के लिए अपने सर्वर एनवायरमेंट और FCM की गाइड देखें.

बैकएंड पर, भेजने के तरीके में, विषय का पसंदीदा नाम बताएं, जैसा कि यहां दिखाया गया है:

Node.js के लिए

// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  topic: topic
};

// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Java

// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setTopic(topic)
    .build();

// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);

Python

# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    topic=topic,
)

# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)

शुरू करें

// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Topic: topic,
}

// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)

C#

// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Topic = topic,
};

// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
    "topic" : "foo-bar",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message"
      }
   }
}

cURL निर्देश:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "message": {
    "topic" : "foo-bar",
    "notification": {
      "body": "This is a Firebase Cloud Messaging Topic Message!",
      "title": "FCM Message"
    }
  }
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

विषयों के कॉम्बिनेशन को मैसेज भेजने के लिए, condition की जानकारी दें. यह एक बूलियन एक्सप्रेशन है, जो टारगेट किए गए विषयों के बारे में बताता है. उदाहरण के लिए, इस शर्त से उन डिवाइसों पर मैसेज भेजे जाएंगे जिन्होंने TopicA और TopicB या TopicC की सदस्यता ली है:

"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"

FCM सबसे पहले ब्रैकेट में मौजूद किसी भी शर्त का आकलन करता है. इसके बाद, बाईं से दाईं ओर एक्सप्रेशन का आकलन करता है. ऊपर दिए गए एक्सप्रेशन में, किसी एक विषय की सदस्यता लेने वाले उपयोगकर्ता को मैसेज नहीं मिलता. इसी तरह, TopicA की सदस्यता न लेने वाले लोगों को भी मैसेज नहीं मिलता. इन कॉम्बिनेशन को यह कॉन्टेंट मिलता है:

  • TopicA और TopicB
  • TopicA और TopicC

कंडिशनल एक्सप्रेशन में ज़्यादा से ज़्यादा पांच विषय शामिल किए जा सकते हैं.

किसी शर्त पर भेजने के लिए:

Node.js के लिए

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';

// See documentation on defining a message payload.
const message = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  condition: condition
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Java

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setCondition(condition)
    .build();

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);

Python

# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"

# See documentation on defining a message payload.
message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    condition=condition,
)

# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)

शुरू करें

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Condition: condition,
}

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)

C#

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
var message = new Message()
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Condition = condition,
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
   "message":{
    "condition": "'dogs' in topics || 'cats' in topics",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message",
    }
  }
}

cURL निर्देश:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "notification": {
    "title": "FCM Message",
    "body": "This is a Firebase Cloud Messaging Topic Message!",
  },
  "condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

डिवाइस ग्रुप में मैसेज भेजें

डिवाइस ग्रुप को मैसेज भेजने के लिए, एचटीटीपी v1 एपीआई का इस्तेमाल करें. अगर एचटीटीपी या XMPP या लेगसी प्रोटोकॉल पर आधारित Firebase के लिए Node.js के लिए Firebase एडमिन SDK के पुराने वर्शन में से किसी का भी इस्तेमाल किया जा रहा है, तो हमारा सुझाव है कि आप जल्द से जल्द एचटीटीपी v1 एपीआई पर माइग्रेट करें. लेगसी 'भेजें' एपीआई को जून 2024 में बंद कर दिया जाएगा और हटा दिया जाएगा.

किसी डिवाइस ग्रुप को मैसेज भेजना, किसी डिवाइस पर मैसेज भेजने जैसा ही है. इसमें एक ही तरीके का इस्तेमाल करके अनुरोध भेजने की अनुमति दी जाती है. token फ़ील्ड को ग्रुप सूचना कुंजी पर सेट करें:

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ",
      "data":{
        "hello": "This is a Firebase Cloud Messaging device group message!"
      }
   }
}

cURL निर्देश

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "data":{
     "hello": "This is a Firebase Cloud Messaging device group message!"
   },
   "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ"
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

मैसेज का बैच भेजें

एडमिन SDK टूल की मदद से, बैच में मैसेज भेजे जा सकते हैं. ज़्यादा से ज़्यादा 500 मैसेज को एक बैच में ग्रुप करके, उन्हें एक ही एपीआई कॉल में भेजा जा सकता है. इससे हर मैसेज के लिए अलग-अलग एचटीटीपी अनुरोध भेजने की तुलना में, बेहतर परफ़ॉर्मेंस में सुधार होता है.

इस सुविधा का इस्तेमाल, अपनी पसंद के मुताबिक मैसेज का सेट बनाने और उन्हें ईमेल पाने वाले अलग-अलग लोगों को भेजने के लिए किया जा सकता है. इसमें विषय या डिवाइस के रजिस्ट्रेशन टोकन की जानकारी भी शामिल होती है. उदाहरण के लिए, इस सुविधा का इस्तेमाल तब करें, जब आपको मैसेज के मुख्य हिस्से में, अलग-अलग जानकारी के साथ अलग-अलग ऑडियंस को एक साथ मैसेज भेजना हो.

Node.js के लिए

// Create a list containing up to 500 messages.
const messages = [];
messages.push({
  notification: { title: 'Price drop', body: '5% off all electronics' },
  token: registrationToken,
});
messages.push({
  notification: { title: 'Price drop', body: '2% off all books' },
  topic: 'readers-club',
});

getMessaging().sendAll(messages)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

Java

// Create a list containing up to 500 messages.
List<Message> messages = Arrays.asList(
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("5% off all electronics")
            .build())
        .setToken(registrationToken)
        .build(),
    // ...
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("2% off all books")
            .build())
        .setTopic("readers-club")
        .build()
);

BatchResponse response = FirebaseMessaging.getInstance().sendAll(messages);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");

Python

# Create a list containing up to 500 messages.
messages = [
    messaging.Message(
        notification=messaging.Notification('Price drop', '5% off all electronics'),
        token=registration_token,
    ),
    # ...
    messaging.Message(
        notification=messaging.Notification('Price drop', '2% off all books'),
        topic='readers-club',
    ),
]

response = messaging.send_all(messages)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))

शुरू करें

// Create a list containing up to 500 messages.
messages := []*messaging.Message{
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "5% off all electronics",
		},
		Token: registrationToken,
	},
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "2% off all books",
		},
		Topic: "readers-club",
	},
}

br, err := client.SendAll(context.Background(), messages)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)

C#

// Create a list containing up to 500 messages.
var messages = new List<Message>()
{
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "5% off all electronics",
        },
        Token = registrationToken,
    },
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "2% off all books",
        },
        Topic = "readers-club",
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachAsync(messages);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");

डिवाइस को सीधे बूट करने की सुविधा वाले मैसेज भेजना (सिर्फ़ Android पर)

एचटीटीपी v1 या लेगसी एचटीटीपी एपीआई का इस्तेमाल करके, डायरेक्ट बूट मोड वाले डिवाइसों पर मैसेज भेजे जा सकते हैं. डिवाइस को डायरेक्ट बूट मोड में भेजने से पहले, पक्का करें कि आपने क्लाइंट डिवाइस को डायरेक्ट बूट मोड में FCM मैसेज पाएं चालू करने के चरणों को पूरा कर लिया है.

FCM v1 एचटीटीपी एपीआई का इस्तेमाल करके भेजना

मैसेज के अनुरोध में, अनुरोध के मुख्य हिस्से के AndroidConfig विकल्पों में "direct_boot_ok" : true कुंजी शामिल होनी चाहिए. उदाहरण के लिए:

https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
  "message":{
    "token" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
    "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "android": {
      "direct_boot_ok": true,
    },
}

FCM का पुराना एचटीटीपी एपीआई इस्तेमाल करके भेजना

मैसेज के अनुरोध में, अनुरोध के मुख्य हिस्से में सबसे ऊपर वाले लेवल पर, "direct_boot_ok" : true कुंजी शामिल होनी चाहिए. उदाहरण के लिए:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  "direct_boot_ok" : true
}

अनुरोध के मुख्य हिस्से में, इस कुंजी का इस्तेमाल करके भेजे गए मैसेज उन डिवाइसों पर मैनेज किए जा सकते हैं जिन पर फ़िलहाल डायरेक्ट बूट मोड चालू है. ऐसा तब भी किया जा सकता है, जब डिवाइस इस मोड में न हो.

अलग-अलग प्लैटफ़ॉर्म पर मैसेज को अपनी पसंद के मुताबिक बनाएं

Firebase एडमिन SDK टूल और FCM v1 एचटीटीपी प्रोटोकॉल, दोनों ही आपके मैसेज अनुरोधों को message ऑब्जेक्ट में उपलब्ध सभी फ़ील्ड सेट करने की अनुमति देते हैं. ऐसे कॉन्टेंट के कुछ उदाहरण यहां दिए गए हैं:

  • फ़ील्ड का एक सामान्य सेट, जिसे मैसेज पाने वाले सभी ऐप्लिकेशन इंस्टेंस से समझा जा सकता है.
  • फ़ील्ड के खास सेट, जैसे कि AndroidConfig और WebpushConfig का मतलब, सिर्फ़ बताए गए प्लैटफ़ॉर्म पर चल रहे ऐप्लिकेशन इंस्टेंस के हिसाब से किया जाता है.

अलग-अलग प्लैटफ़ॉर्म के हिसाब से ब्लॉक करके, अलग-अलग प्लैटफ़ॉर्म के लिए मैसेज को अपनी पसंद के मुताबिक बनाया जा सकता है. इससे यह पक्का किया जा सकता है कि मैसेज मिलने पर वे सही तरीके से हैंडल किए जाएं. FCM बैकएंड सभी पैरामीटर को ध्यान में रखेगा और हर प्लैटफ़ॉर्म के हिसाब से मैसेज दिखाएगा.

कॉमन फ़ील्ड का इस्तेमाल कब करना चाहिए

सामान्य फ़ील्ड का इस्तेमाल तब करें, जब:

  • सभी प्लैटफ़ॉर्म — Apple, Android, और वेब पर ऐप्लिकेशन इंस्टेंस को टारगेट करना
  • विषयों के लिए मैसेज भेज रहे हैं

किसी भी प्लैटफ़ॉर्म पर ऐप्लिकेशन के सभी इंस्टेंस, इन सामान्य फ़ील्ड को समझ सकते हैं:

प्लैटफ़ॉर्म के हिसाब से बने फ़ील्ड का इस्तेमाल कब करना चाहिए

प्लैटफ़ॉर्म के हिसाब से बने फ़ील्ड का इस्तेमाल तब करें, जब:

  • सिर्फ़ खास प्लैटफ़ॉर्म पर फ़ील्ड भेजें
  • कॉमन फ़ील्ड के साथ-साथ प्लैटफ़ॉर्म के हिसाब से भी फ़ील्ड भेजें

अगर आपको सिर्फ़ किसी प्लैटफ़ॉर्म पर वैल्यू भेजनी हैं, तो सामान्य फ़ील्ड का इस्तेमाल न करें. प्लैटफ़ॉर्म के हिसाब से बनाए गए फ़ील्ड इस्तेमाल करें. उदाहरण के लिए, अगर Android को नहीं, बल्कि सिर्फ़ Apple प्लैटफ़ॉर्म और वेब पर सूचना भेजना है, तो आपको फ़ील्ड के दो अलग-अलग सेट का इस्तेमाल करना होगा. पहला, Apple के लिए और दूसरा वेब के लिए.

खास डिलीवरी विकल्पों वाले मैसेज भेजते समय, उन्हें सेट करने के लिए प्लैटफ़ॉर्म के अलग-अलग फ़ील्ड का इस्तेमाल करें. आपके पास हर प्लैटफ़ॉर्म के लिए अलग-अलग वैल्यू तय करने का विकल्प है. हालांकि, जब आपको सभी प्लैटफ़ॉर्म पर एक जैसी वैल्यू सेट करनी हो, तब भी आपको प्लैटफ़ॉर्म के हिसाब से बने फ़ील्ड इस्तेमाल करने होंगे. ऐसा इसलिए है, क्योंकि हर प्लैटफ़ॉर्म इस वैल्यू को थोड़ा अलग तरीके से समझ सकता है. उदाहरण के लिए, Android पर लाइव स्ट्रीम खत्म होने का समय सेकंड में सेट होता है, जबकि Apple पर यह खत्म होने की तारीख के तौर पर सेट होता है.

उदाहरण: रंग और आइकॉन के विकल्पों के साथ सूचना वाला मैसेज

मैसेज भेजने के इस उदाहरण में, सभी प्लैटफ़ॉर्म पर सूचनाओं का एक सामान्य टाइटल और कॉन्टेंट भेजा जाता है. हालांकि, यह Android डिवाइसों पर कुछ प्लैटफ़ॉर्म के लिए खास बदलाव भी भेजता है.

Android के लिए, अनुरोध Android डिवाइसों पर दिखाने के लिए एक खास आइकॉन और रंग सेट करता है. जैसा कि AndroidNotification के रेफ़रंस में बताया गया है, रंग का ब्यौरा #rrggbb फ़ॉर्मैट में दिया गया है. साथ ही, इमेज, ड्रॉ करने लायक आइकॉन संसाधन होनी चाहिए, जो Android ऐप्लिकेशन से जुड़ी हो.

उपयोगकर्ता के डिवाइस पर होने वाले विज़ुअल असर का अनुमान यहां दिया गया है:

दो डिवाइसों की आसान ड्रॉइंग, जिसमें एक डिवाइस में पसंद का आइकॉन और रंग दिख रहा है

Node.js के लिए

const topicName = 'industry-tech';

const message = {
  notification: {
    title: '`$FooCorp` up 1.43% on the day',
    body: 'FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  android: {
    notification: {
      icon: 'stock_ticker_update',
      color: '#7e55c3'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Java

Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setAndroidConfig(AndroidConfig.builder()
        .setTtl(3600 * 1000)
        .setNotification(AndroidNotification.builder()
            .setIcon("stock_ticker_update")
            .setColor("#f45342")
            .build())
        .build())
    .setApnsConfig(ApnsConfig.builder()
        .setAps(Aps.builder()
            .setBadge(42)
            .build())
        .build())
    .setTopic("industry-tech")
    .build();

Python

message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    android=messaging.AndroidConfig(
        ttl=datetime.timedelta(seconds=3600),
        priority='normal',
        notification=messaging.AndroidNotification(
            icon='stock_ticker_update',
            color='#f45342'
        ),
    ),
    apns=messaging.APNSConfig(
        payload=messaging.APNSPayload(
            aps=messaging.Aps(badge=42),
        ),
    ),
    topic='industry-tech',
)

शुरू करें

oneHour := time.Duration(1) * time.Hour
badge := 42
message := &messaging.Message{
	Notification: &messaging.Notification{
		Title: "$GOOG up 1.43% on the day",
		Body:  "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
	},
	Android: &messaging.AndroidConfig{
		TTL: &oneHour,
		Notification: &messaging.AndroidNotification{
			Icon:  "stock_ticker_update",
			Color: "#f45342",
		},
	},
	APNS: &messaging.APNSConfig{
		Payload: &messaging.APNSPayload{
			Aps: &messaging.Aps{
				Badge: &badge,
			},
		},
	},
	Topic: "industry-tech",
}

C#

var message = new Message
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Android = new AndroidConfig()
    {
        TimeToLive = TimeSpan.FromHours(1),
        Notification = new AndroidNotification()
        {
            Icon = "stock_ticker_update",
            Color = "#f45342",
        },
    },
    Apns = new ApnsConfig()
    {
        Aps = new Aps()
        {
            Badge = 42,
        },
    },
    Topic = "industry-tech",
};

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"`$FooCorp` up 1.43% on the day",
       "body":"FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day."
     },
     "android":{
       "notification":{
         "icon":"stock_ticker_update",
         "color":"#7e55c3"
       }
     }
   }
 }

मैसेज के मुख्य हिस्से में, प्लैटफ़ॉर्म के हिसाब से बने ब्लॉक में उपलब्ध कुंजियों के बारे में पूरी जानकारी पाने के लिए, एचटीटीपी v1 के रेफ़रंस वाले दस्तावेज़ देखें.

उदाहरण: पसंद के मुताबिक इमेज के साथ सूचना वाला मैसेज

भेजने के अनुरोध के इस उदाहरण में, सभी प्लैटफ़ॉर्म पर सूचना का एक ही टाइटल भेजा गया है. हालांकि, इससे एक इमेज भी भेजी जाती है. यहां उपयोगकर्ता के डिवाइस पर होने वाले विज़ुअल इफ़ेक्ट का अनुमान दिया गया है:

डिसप्ले सूचना में इमेज की आसान ड्रॉइंग

Node.js के लिए

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Sparky says hello!'
  },
  android: {
    notification: {
      imageUrl: 'https://foo.bar.pizza-monster.png'
    }
  },
  apns: {
    payload: {
      aps: {
        'mutable-content': 1
      }
    },
    fcm_options: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  webpush: {
    headers: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Sparky says hello!",
     },
     "android":{
       "notification":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "mutable-content":1
         }
       },
       "fcm_options": {
           "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "webpush":{
       "headers":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     }
   }
 }

मैसेज के मुख्य हिस्से में, प्लैटफ़ॉर्म के हिसाब से बने ब्लॉक में उपलब्ध कुंजियों के बारे में पूरी जानकारी पाने के लिए, एचटीटीपी v1 के रेफ़रंस वाले दस्तावेज़ देखें.

उदाहरण: संबंधित क्लिक कार्रवाई के साथ सूचना वाला मैसेज

भेजने के अनुरोध के नीचे दिए गए उदाहरण में, सभी प्लैटफ़ॉर्म पर सूचना का एक सामान्य टाइटल भेजा गया है. हालांकि, सूचना से इंटरैक्ट करने वाले उपयोगकर्ता के जवाब में, ऐप्लिकेशन के लिए एक कार्रवाई भी भेजी जाती है. उपयोगकर्ता के डिवाइस पर होने वाले विज़ुअल असर का अनुमान यहां दिया गया है:

एक सामान्य ड्रॉइंग, जिसमें कोई उपयोगकर्ता वेब पेज को खोल रहा है

Node.js के लिए

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Breaking News....'
  },
  android: {
    notification: {
      clickAction: 'news_intent'
    }
  },
  apns: {
    payload: {
      aps: {
        'category': 'INVITE_CATEGORY'
      }
    }
  },
  webpush: {
    fcmOptions: {
      link: 'breakingnews.html'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Breaking News...",
     },
     "android":{
       "notification":{
         "click_action":"news_intent"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "category" : "INVITE_CATEGORY"
         }
       },
     },
     "webpush":{
       "fcm_options":{
         "link":"breakingnews.html"
       }
     }
   }
 }

मैसेज के मुख्य हिस्से में, प्लैटफ़ॉर्म के हिसाब से बने ब्लॉक में उपलब्ध कुंजियों के बारे में पूरी जानकारी पाने के लिए, एचटीटीपी v1 के रेफ़रंस वाले दस्तावेज़ देखें.

उदाहरण: स्थानीय भाषा के अनुसार सुविधा के विकल्पों के साथ सूचना वाला मैसेज

नीचे दिए गए उदाहरण में मैसेज भेजने का अनुरोध करने पर क्लाइंट को स्थानीय भाषा में मैसेज दिखाने के लिए, स्थानीय भाषा के अनुसार विकल्प भेजा जाता है. उपयोगकर्ता के डिवाइस पर होने वाले विज़ुअल असर का अनुमान यहां दिया गया है:

दो डिवाइसों की आसान ड्रॉइंग, जिसमें टेक्स्ट को अंग्रेज़ी और स्पैनिश में दिखाया जा रहा है

Node.js के लिए

var topicName = 'industry-tech';

var message = {
  android: {
    ttl: 3600000,
    notification: {
      bodyLocKey: 'STOCK_NOTIFICATION_BODY',
      bodyLocArgs: ['FooCorp', '11.80', '835.67', '1.43']
    }
  },
  apns: {
    payload: {
      aps: {
        alert: {
          locKey: 'STOCK_NOTIFICATION_BODY',
          locArgs: ['FooCorp', '11.80', '835.67', '1.43']
        }
      }
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
             "topic":"Tech",
             "android":{
               "ttl":"3600s",
               "notification":{
                 "body_loc_key": "STOCK_NOTIFICATION_BODY",
                 "body_loc_args":  ["FooCorp", "11.80", "835.67", "1.43"],
               },
             },
             "apns":{
               "payload":{
                 "aps":{
                   "alert" : {
                     "loc-key": "STOCK_NOTIFICATION_BODY",
                     "loc-args":  ["FooCorp", "11.80", "835.67", "1.43"],
                    },
                 },
               },
             },
  },
}'

मैसेज के मुख्य हिस्से में, प्लैटफ़ॉर्म के हिसाब से बने ब्लॉक में उपलब्ध कुंजियों के बारे में पूरी जानकारी पाने के लिए, एचटीटीपी v1 के रेफ़रंस वाले दस्तावेज़ देखें.

एचटीटीपी v1 एपीआई के लिए REST के गड़बड़ी के कोड

एचटीटीपी v1 एपीआई के लिए एचटीटीपी गड़बड़ी के जवाबों में गड़बड़ी का कोड, गड़बड़ी का मैसेज, और गड़बड़ी की स्थिति शामिल होती है. इनमें, गड़बड़ी के बारे में ज़्यादा जानकारी के साथ details कलेक्शन भी शामिल हो सकता है.

यहां गड़बड़ी के दो जवाबों के नमूने दिए गए हैं:

उदाहरण 1: डेटा मैसेज में अमान्य वैल्यू के साथ एचटीटीपी v1 एपीआई अनुरोध से गड़बड़ी का रिस्पॉन्स

{
  "error": {
    "code": 400,
    "message": "Invalid value at 'message.data[0].value' (TYPE_STRING), 12",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.BadRequest",
        "fieldViolations": [
          {
            "field": "message.data[0].value",
            "description": "Invalid value at 'message.data[0].value' (TYPE_STRING), 12"
          }
        ]
      }
    ]
  }
}

दूसरा उदाहरण: अमान्य रजिस्ट्रेशन टोकन वाले एचटीटीपी v1 एपीआई अनुरोध से मिली गड़बड़ी का रिस्पॉन्स

{
  "error": {
    "code": 400,
    "message": "The registration token is not a valid FCM registration token",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.firebase.fcm.v1.FcmError",
        "errorCode": "INVALID_ARGUMENT"
      }
    ]
   }
}

ध्यान दें कि दोनों मैसेज का कोड और स्टेटस एक जैसा है. हालांकि, ब्यौरे वाले अरे में अलग-अलग तरह की वैल्यू दी गई हैं. पहले उदाहरण में type.googleapis.com/google.rpc.BadRequest का टाइप है, जो अनुरोध की वैल्यू में गड़बड़ी को दिखाता है. type.googleapis.com/google.firebase.fcm.v1.FcmError टाइप वाले दूसरे उदाहरण में, FCM से जुड़ी गड़बड़ी है. कई गड़बड़ियों के लिए, ब्यौरे वाले अरे में वह जानकारी शामिल होती है जिसकी ज़रूरत आपको डीबग करने और समाधान खोजने के लिए होती है.

नीचे दी गई टेबल में, FCM v1 REST API के गड़बड़ी कोड और उनसे जुड़ी जानकारी दी गई है.

Error Code ब्यौरा और ठीक करने का तरीका
UNSPECIFIED_ERROR इस गड़बड़ी के बारे में और कोई जानकारी उपलब्ध नहीं है. कोई नहीं.
INVALID_ARGUMENT (एचटीटीपी गड़बड़ी कोड = 400) अनुरोध के पैरामीटर अमान्य थे. यह बताने के लिए कि कौनसा फ़ील्ड अमान्य था, google.rpc.BadRequest टाइप का एक्सटेंशन दिखाया जाता है. संभावित वजहों में गलत रजिस्ट्रेशन, पैकेज का गलत नाम, मैसेज बहुत बड़ा होना, गलत डेटा कुंजी, गलत TTL या दूसरे अमान्य पैरामीटर शामिल हैं.
अमान्य रजिस्ट्रेशन: सर्वर को भेजे गए रजिस्ट्रेशन टोकन के फ़ॉर्मैट की जांच करें. पक्का करें कि यह रजिस्ट्रेशन टोकन से, क्लाइंट ऐप्लिकेशन को FCM के साथ रजिस्टर करने पर मिला है. टोकन में काट-छांट न करें या अतिरिक्त वर्ण न जोड़ें.
पैकेज का अमान्य नाम: पक्का करें कि मैसेज में ऐसे रजिस्ट्रेशन टोकन के लिए ईमेल भेजा गया हो जिसके पैकेज का नाम, अनुरोध में दी गई वैल्यू से मेल खाता हो.
मैसेज बहुत बड़ा है: देखें कि मैसेज में शामिल पेलोड डेटा का कुल साइज़, FCM की तय सीमा से ज़्यादा न हो: ज़्यादातर मैसेज के लिए 4096 बाइट या विषयों के मैसेज के मामले में 2048 बाइट. इसमें कुंजियां और वैल्यू, दोनों शामिल होती हैं.
अमान्य डेटा कुंजी: पक्का करें कि पेलोड डेटा में कोई ऐसी कुंजी (जैसे कि from या gcm या Google की ओर से प्रीफ़िक्स किया गया कोई भी मान) न हो जिसका इस्तेमाल FCM के ज़रिए अंदरूनी तौर पर किया जाता है. ध्यान दें कि FCM कुछ शब्दों (जैसे कि संक्षिप्त_key) का इस्तेमाल भी करता है. हालांकि, पेलोड में इनका इस्तेमाल किया जा सकता है. ऐसा होने पर, पेलोड वैल्यू की जगह FCM वैल्यू लागू हो जाएगी.
अमान्य TTL: देखें कि ttl में इस्तेमाल किया गया मान एक पूर्णांक हो, जो 0 से 24,19,200 (4 हफ़्ते) के बीच की अवधि को सेकंड में दिखाता है.
अमान्य पैरामीटर: देखें कि दिए गए पैरामीटर का नाम और टाइप सही है या नहीं.
UNREGISTERED (एचटीटीपी गड़बड़ी कोड = 404) ऐप्लिकेशन इंस्टेंस का रजिस्ट्रेशन FCM से रद्द किया गया. आम तौर पर, इसका मतलब है कि इस्तेमाल किया गया टोकन अब मान्य नहीं है और नए टोकन का इस्तेमाल करना ज़रूरी है. यह गड़बड़ी, रजिस्ट्रेशन टोकन मौजूद न होने या बिना रजिस्ट्रेशन वाले टोकन की वजह से हो सकती है.
रजिस्ट्रेशन मौजूद नहीं है: अगर मैसेज के लिए token वैल्यू दी गई है, तो देखें कि अनुरोध में रजिस्ट्रेशन टोकन मौजूद है या नहीं.
रजिस्टर नहीं किया गया: मौजूदा रजिस्ट्रेशन टोकन कई स्थितियों में मान्य होना बंद हो सकता है. इनमें ये शामिल हैं:
- अगर क्लाइंट ऐप्लिकेशन का FCM के साथ रजिस्ट्रेशन रद्द किया जाता है.
- अगर क्लाइंट ऐप्लिकेशन का रजिस्ट्रेशन अपने-आप रद्द हो जाता है, तो ऐसा तब हो सकता है, जब उपयोगकर्ता ऐप्लिकेशन को अनइंस्टॉल कर देता है. उदाहरण के लिए, iOS पर, अगर एपीएन के लिए सुझाव देने वाली सेवा ने एपीएन टोकन के अमान्य होने की शिकायत की है.
- अगर रजिस्ट्रेशन टोकन की समयसीमा खत्म हो जाती है (उदाहरण के लिए, Google, रजिस्ट्रेशन टोकन को रीफ़्रेश कर सकता है या iOS डिवाइसों के लिए एपीएन टोकन की समयसीमा खत्म हो गई है).
- अगर क्लाइंट ऐप्लिकेशन को अपडेट किया गया है, लेकिन नए वर्शन को मैसेज पाने के लिए कॉन्फ़िगर नहीं किया गया है.
ऐसे सभी मामलों में, ऐप्लिकेशन सर्वर से इस रजिस्ट्रेशन टोकन को हटाएं और मैसेज भेजने के लिए इसका इस्तेमाल करना बंद करें.
SENDER_ID_MISMATCH (एचटीटीपी गड़बड़ी कोड = 403) पुष्टि किए गए भेजने वाले का आईडी, रजिस्ट्रेशन टोकन के लिए भेजने वाले आईडी से अलग होता है. रजिस्ट्रेशन टोकन, ईमेल भेजने वाले कुछ खास ग्रुप से जुड़ा होता है. जब कोई क्लाइंट ऐप्लिकेशन FCM के लिए रजिस्टर होता है, तो उसे यह बताना होगा कि किन ईमेल पतों को मैसेज भेजने की अनुमति है. क्लाइंट ऐप्लिकेशन पर मैसेज भेजते समय, आपको भेजने वाले के आईडी में से किसी एक का इस्तेमाल करना चाहिए. अगर ईमेल भेजने वाले किसी अन्य व्यक्ति का इस्तेमाल किया जाता है, तो मौजूदा रजिस्ट्रेशन टोकन काम नहीं करेंगे.
QUOTA_EXCEEDED (एचटीटीपी गड़बड़ी कोड = 429) मैसेज के टारगेट के लिए, भेजने की सीमा पार हो गई है. यह बताने के लिए कि कौनसा कोटा खत्म हुआ, google.rpc.QuotaFailure टाइप का एक्सटेंशन दिखाया जाता है. यह गड़बड़ी, मैसेज की तय की गई सीमा से ज़्यादा होने, डिवाइस पर मैसेज भेजने की तय सीमा या फिर विषय के मैसेज की तय सीमा पार होने की वजह से हो सकती है.
मैसेज भेजने की दर पार हो गई है: मैसेज भेजने की दर बहुत ज़्यादा है. आपको मैसेज भेजने की कुल दर को कम करना होगा. अस्वीकार किए गए मैसेज को फिर से भेजने के लिए, कम से कम एक मिनट की देरी से एक्सपोनेन्शियल बैकऑफ़ का इस्तेमाल करें.
डिवाइस पर मैसेज की दर पार हो गई है: किसी खास डिवाइस पर मैसेज भेजने की दर बहुत ज़्यादा है. एक डिवाइस पर मैसेज भेजने की दर की सीमादेखें. इस डिवाइस पर भेजे गए मैसेज की संख्या कम करें और फिर से भेजने के लिए एक्सपोनेन्शियल बैकऑफ़ का इस्तेमाल करें.
विषय से जुड़े मैसेज की दर ज़्यादा हो गई है: किसी खास विषय पर, सदस्यों को भेजे जाने वाले मैसेज की दर बहुत ज़्यादा है. इस विषय के लिए भेजे गए मैसेज की संख्या कम करें. साथ ही, फिर से भेजने के लिए, कम से कम एक मिनट की देरी से एक्सपोनेन्शियल बैकऑफ़ का इस्तेमाल करें.
UNAVAILABLE (एचटीटीपी गड़बड़ी कोड = 503) सर्वर ओवरलोड है. सर्वर समय पर अनुरोध को प्रोसेस नहीं कर सका. फिर से वही अनुरोध करें, लेकिन आपको ये काम करने होंगे:
- अगर FCM कनेक्शन सर्वर के रिस्पॉन्स में शामिल किया गया 'फिर से कोशिश करें' हेडर शामिल है, तो उसे लागू करें.
- फिर से कोशिश करने के तरीके में एक्स्पोनेंशियल बैक-ऑफ़ लागू करें. (उदाहरण के लिए, अगर आपने पहली बार कोशिश करने से पहले एक सेकंड इंतज़ार किया है, तो अगली कोशिश से कम से कम दो सेकंड पहले इंतज़ार करें और फिर चार सेकंड इंतज़ार करें वगैरह). अगर आप एक से ज़्यादा मैसेज भेज रहे हैं, तो शिकायत लागू करने के बारे में सोचें. ज़्यादा जानकारी के लिए, फिर से की जाने वाली कोशिशों को मैनेज करना देखें. मैसेज भेजने वाले ऐसे लोगों को ब्लॉक कर दिया जाएगा जिनकी वजह से समस्याएं पैदा होती हैं.
INTERNAL (एचटीटीपी गड़बड़ी कोड = 500) कोई अनजान अंदरूनी गड़बड़ी हुई. आपके अनुरोध को प्रोसेस करते समय सर्वर में कोई गड़बड़ी हुई. दोबारा की जाने वाली कोशिशों को मैनेज करना में दिए गए सुझावों का पालन करके, उसी अनुरोध को फिर से आज़माया जा सकता है. अगर गड़बड़ी बनी रहती है, तो कृपया Firebase सहायता टीम से संपर्क करें.
THIRD_PARTY_AUTH_ERROR (एचटीटीपी गड़बड़ी कोड = 401) एपीएन सर्टिफ़िकेट या वेब पुश ऑथराइज़ेशन कुंजी अमान्य है या मौजूद नहीं है. किसी iOS डिवाइस या वेब पुश रजिस्ट्रेशन को टारगेट करने वाला मैसेज नहीं भेजा जा सका. अपने डेवलपमेंट और प्रोडक्शन क्रेडेंशियल की वैधता की जांच करें.

एडमिन की गड़बड़ी के कोड

नीचे दी गई टेबल में, Firebase एडमिन FCM एपीआई के गड़बड़ी कोड और उनसे जुड़ी जानकारी दी गई है. साथ ही, गड़बड़ी को ठीक करने के सुझाए गए तरीके भी दिए गए हैं.

Error Code ब्यौरा और ठीक करने का तरीका
messaging/invalid-argument FCM तरीके में अमान्य तर्क दिया गया. गड़बड़ी के मैसेज में ज़्यादा जानकारी होनी चाहिए.
messaging/invalid-recipient मैसेज पाने वाला व्यक्ति गलत है. गड़बड़ी के मैसेज में ज़्यादा जानकारी होनी चाहिए.
messaging/invalid-payload मैसेज पेलोड ऑब्जेक्ट अमान्य है. गड़बड़ी के मैसेज में ज़्यादा जानकारी होनी चाहिए.
messaging/invalid-data-payload-key डेटा मैसेज पेलोड में गलत कुंजी है. पाबंदी वाली कुंजियों के बारे में जानने के लिए, DataMessagePayload के रेफ़रंस दस्तावेज़ देखें.
messaging/payload-size-limit-exceeded दिए गए मैसेज पेलोड का साइज़, FCM के साइज़ की सीमाओं से ज़्यादा है. ज़्यादातर मैसेज के लिए, यह सीमा 4096 बाइट होती है. विषयों के लिए भेजे गए मैसेज के लिए, यह सीमा 2048 बाइट है. पेलोड के कुल साइज़ में कुंजियां और वैल्यू, दोनों शामिल होती हैं.
messaging/invalid-options मैसेज के विकल्पों के लिए अमान्य ऑब्जेक्ट दिया गया था. गड़बड़ी के मैसेज में ज़्यादा जानकारी होनी चाहिए.
messaging/invalid-registration-token अमान्य रजिस्ट्रेशन टोकन दिया गया. पक्का करें कि यह उस रजिस्ट्रेशन टोकन से मेल खाता हो जो क्लाइंट ऐप्लिकेशन को FCM के साथ रजिस्टर करने पर मिलता है. इसमें काट-छांट न करें या अतिरिक्त वर्ण न जोड़ें.
messaging/registration-token-not-registered दिया गया रजिस्ट्रेशन टोकन रजिस्टर नहीं किया गया है. पहले से मान्य रजिस्ट्रेशन टोकन को कई वजहों से रद्द किया जा सकता है. जैसे:
  • क्लाइंट ऐप्लिकेशन ने FCM से अपना रजिस्ट्रेशन खुद रद्द किया है.
  • क्लाइंट ऐप्लिकेशन का रजिस्ट्रेशन अपने-आप रद्द हो गया. ऐसा तब हो सकता है, जब उपयोगकर्ता ऐप्लिकेशन को अनइंस्टॉल कर देता है. इसके अलावा, Apple के प्लैटफ़ॉर्म पर अगर एपीएन फ़ीडबैक सेवा ने एपीएन टोकन के अमान्य होने की शिकायत की है, तब ऐसा हो सकता है.
  • रजिस्ट्रेशन टोकन की समयसीमा खत्म हो गई है. उदाहरण के लिए, Google यह तय कर सकता है कि रजिस्ट्रेशन टोकन रीफ़्रेश किए जाएं या हो सकता है कि Apple डिवाइसों के लिए, एपीएन टोकन की समयसीमा खत्म हो गई हो.
  • क्लाइंट ऐप्लिकेशन को अपडेट किया गया था, लेकिन नए वर्शन को मैसेज पाने के लिए कॉन्फ़िगर नहीं किया गया है.
ऐसे सभी मामलों में, इस रजिस्ट्रेशन टोकन को हटाएं और मैसेज भेजने के लिए इसका इस्तेमाल करना बंद करें.
messaging/invalid-package-name यह मैसेज ऐसे रजिस्ट्रेशन टोकन के बारे में था जिसके पैकेज का नाम, दिए गए restrictedPackageName विकल्प से मेल नहीं खाता.
messaging/message-rate-exceeded किसी खास टारगेट को भेजे जाने वाले मैसेज की दर बहुत ज़्यादा है. इस डिवाइस या विषय पर भेजे गए मैसेज की संख्या कम करें और इस टारगेट पर तुरंत भेजने की दोबारा कोशिश न करें.
messaging/device-message-rate-exceeded किसी खास डिवाइस पर मैसेज भेजने की दर बहुत ज़्यादा है. इस डिवाइस पर भेजे गए मैसेज की संख्या कम करें और इस डिवाइस पर तुरंत भेजने की फिर से कोशिश न करें.
messaging/topics-message-rate-exceeded किसी खास विषय पर सदस्यों को भेजे जाने वाले मैसेज की दर बहुत ज़्यादा है. इस विषय से जुड़े ईमेल भेजने की संख्या कम करें. साथ ही, इस विषय पर तुरंत मैसेज भेजने की कोशिश न करें.
messaging/too-many-topics रजिस्ट्रेशन टोकन की सदस्यता लेने के बाद, इससे ज़्यादा विषय नहीं लिए जा सकते. इससे ज़्यादा विषयों की सदस्यता नहीं ली जा सकती.
messaging/invalid-apns-credentials किसी Apple डिवाइस को टारगेट करने वाला मैसेज नहीं भेजा जा सका, क्योंकि ज़रूरी एपीएन एसएसएल सर्टिफ़िकेट अपलोड नहीं किया गया या उसकी समयसीमा खत्म हो गई है. देखें कि आपके डेवलपमेंट और प्रोडक्शन सर्टिफ़िकेट कितने मान्य हैं.
messaging/mismatched-credential इस SDK टूल की पुष्टि करने के लिए इस्तेमाल किए गए क्रेडेंशियल के पास, दिए गए रजिस्ट्रेशन टोकन से जुड़े डिवाइस पर मैसेज भेजने की अनुमति नहीं है. पक्का करें कि क्रेडेंशियल और रजिस्ट्रेशन टोकन, दोनों एक ही Firebase प्रोजेक्ट से जुड़े हों. Firebase एडमिन SDK टूल की पुष्टि करने के तरीके से जुड़े दस्तावेज़ के लिए, अपने ऐप्लिकेशन में Firebase जोड़ें लेख पढ़ें.
messaging/authentication-error SDK टूल, FCM सर्वर की पुष्टि नहीं कर सका. पक्का करें कि आपने Firebase एडमिन SDK टूल की पुष्टि ऐसे क्रेडेंशियल से की हो जिसके पास FCM मैसेज भेजने के लिए ज़रूरी अनुमतियां हैं. Firebase एडमिन SDK टूल की पुष्टि करने के तरीके से जुड़े दस्तावेज़ के लिए, अपने ऐप्लिकेशन में Firebase जोड़ें लेख पढ़ें.
messaging/server-unavailable FCM सर्वर समय पर अनुरोध को प्रोसेस नहीं कर सका. फिर से वही अनुरोध करें, लेकिन आपको:
  • अगर Retry-After हेडर, FCM कनेक्शन सर्वर से रिस्पॉन्स के तौर पर शामिल है, तो उसे ध्यान में रखें.
  • फिर से कोशिश करने के तरीके में एक्स्पोनेंशियल बैक-ऑफ़ लागू करें. उदाहरण के लिए, अगर आपने पहली बार कोशिश करने से पहले एक सेकंड इंतज़ार किया है, तो अगली कोशिश से कम से कम दो सेकंड पहले इंतज़ार करें. इसके बाद, चार सेकंड इंतज़ार करें. इसी तरह आगे की कोशिश करते रहें. अगर आप एक से ज़्यादा मैसेज भेज रहे हैं, तो एक ही समय पर सभी मैसेज के लिए नया अनुरोध जारी होने से बचने के लिए, हर एक के लिए अलग से कोई रकम डालें.
मैसेज भेजने वाले ऐसे लोगों को ब्लैकलिस्ट किए जाने का खतरा होता है जिनकी वजह से समस्याएं होती हैं.
messaging/internal-error अनुरोध को प्रोसेस करते समय FCM सर्वर में कोई गड़बड़ी हुई. आप ऊपर messaging/server-unavailable लाइन में बताई गई ज़रूरी शर्तों का पालन करके, वही अनुरोध फिर से कर सकते हैं. अगर गड़बड़ी बनी रहती है, तो कृपया हमारे गड़बड़ी की रिपोर्ट सहायता चैनल से समस्या की शिकायत करें.
messaging/unknown-error एक अज्ञात सर्वर गड़बड़ी दिखाई गई. ज़्यादा जानकारी के लिए, गड़बड़ी के मैसेज में सर्वर का रॉ रिस्पॉन्स देखें. अगर आपको यह गड़बड़ी दिखती है, तो कृपया गड़बड़ी के पूरे मैसेज की शिकायत हमारे गड़बड़ी की रिपोर्ट के सहायता चैनल पर करें.

पुराने ऐप्लिकेशन सर्वर प्रोटोकॉल का इस्तेमाल करके मैसेज भेजें

अगर फ़िलहाल लेगसी प्रोटोकॉल का इस्तेमाल किया जा रहा है, तो इस सेक्शन में दिखाए गए तरीके से मैसेज के अनुरोध बनाएं. ध्यान रखें कि अगर आप एचटीटीपी के ज़रिए एक से ज़्यादा प्लैटफ़ॉर्म पर ईमेल भेज रहे हैं, तो v1 प्रोटोकॉल आपके मैसेज के अनुरोधों को आसान बना सकता है.

चुनिंदा डिवाइसों पर मैसेज भेजें

किसी खास डिवाइस पर मैसेज भेजने के लिए, किसी खास ऐप्लिकेशन इंस्टेंस के रजिस्ट्रेशन टोकन के लिए, to कुंजी को सेट करें. रजिस्ट्रेशन टोकन के बारे में ज़्यादा जानने के लिए, अपने प्लैटफ़ॉर्म के लिए क्लाइंट सेटअप की जानकारी देखें.

एचटीटीपी पोस्ट अनुरोध

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}

एचटीटीपी रिस्पॉन्स

{ "multicast_id": 108,
  "success": 1,
  "failure": 0,
  "results": [
    { "message_id": "1:08" }
  ]
}

XMPP संदेश

<message id="">
  <gcm xmlns="google:mobile:data">
    { "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
  </gcm>
</message>

XMPP जवाब

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "from":"REGID",
      "message_id":"m-1366082849205"
      "message_type":"ack"
  }
  </gcm>
</message>

XMPP कनेक्शन सर्वर, जवाबों के लिए कुछ अन्य विकल्प भी उपलब्ध कराता है. सर्वर रिस्पॉन्स फ़ॉर्मैट देखें.

क्लाइंट ऐप्लिकेशन को डाउनस्ट्रीम मैसेज भेजते समय, मैसेज के विकल्पों की पूरी सूची देखने के लिए, अपने चुने गए कनेक्शन सर्वर प्रोटोकॉल, एचटीटीपी या XMPP की रेफ़रंस जानकारी देखें.

विषयों के लिए मैसेज भेजें

'Firebase क्लाउड से मैसेज' विषय पर मैसेज भेजना, किसी खास डिवाइस या उपयोगकर्ता ग्रुप को मैसेज भेजने जैसा ही है. ऐप्लिकेशन सर्वर, to कुंजी को /topics/yourTopic जैसी वैल्यू पर सेट करता है. डेवलपर, रेगुलर एक्सप्रेशन से मेल खाने वाले किसी भी विषय का नाम चुन सकते हैं: "/topics/[a-zA-Z0-9-_.~%]+".

एक से ज़्यादा विषयों के कॉम्बिनेशन भेजने के लिए, ऐप्लिकेशन सर्वर को condition कुंजी (to कुंजी के बजाय) को एक बूलियन शर्त पर सेट करना होगा, जिससे टारगेट किए गए विषयों के बारे में पता चलता है. उदाहरण के लिए, उन डिवाइसों पर मैसेज भेजने के लिए जिन्होंने TopicA और TopicB या TopicC की सदस्यता ली है:

'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

FCM सबसे पहले ब्रैकेट में मौजूद किसी भी शर्त का आकलन करता है. इसके बाद, बाईं से दाईं ओर एक्सप्रेशन का आकलन करता है. ऊपर दिए गए एक्सप्रेशन में, किसी एक विषय की सदस्यता लेने वाले उपयोगकर्ता को मैसेज नहीं मिलता. इसी तरह, अगर उपयोगकर्ता ने TopicA की सदस्यता नहीं ली है, तो उसे भी मैसेज नहीं मिलता. इन कॉम्बिनेशन को ये फ़ायदे मिलते हैं:

  • TopicA और TopicB
  • TopicA और TopicC

कंडिशनल एक्सप्रेशन में ज़्यादा से ज़्यादा पांच विषय शामिल किए जा सकते हैं. साथ ही, ब्रैकेट का इस्तेमाल किया जा सकता है. इस्तेमाल किए जा सकने वाले ऑपरेटर: &&, ||.

विषय एचटीटीपी पोस्ट अनुरोध

किसी एक विषय पर भेजें:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA


"कुत्ते" या "बिल्लियां" विषय की सदस्यता वाले डिवाइस पर भेजें:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA


विषय एचटीटीपी रिस्पॉन्स

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

विषय XMPP संदेश

किसी एक विषय पर भेजें:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

"कुत्ते" या "बिल्लियां" विषय की सदस्यता वाले डिवाइस पर भेजें:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

विषय XMPP जवाब

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

इस दौरान, FCM सर्वर विषय से जुड़े अनुरोध भेजने के अनुरोध को पूरा होने या न होने में 30 सेकंड तक की देरी कर सकता है. पक्का करें कि ऐप्लिकेशन सर्वर की टाइम आउट वैल्यू, उसी हिसाब से सेट की गई हो.

डिवाइस ग्रुप में मैसेज भेजें

काम नहीं करने वाले लेगसी एपीआई इस्तेमाल करके किसी डिवाइस ग्रुप को मैसेज भेजना, किसी अलग डिवाइस पर मैसेज भेजने जैसा ही है. डिवाइस ग्रुप के लिए, to पैरामीटर को सूचना की खास कुंजी पर सेट करें. इस सेक्शन में दिए गए उदाहरणों में, लेगसी एचटीटीपी और XMPP प्रोटोकॉल में डिवाइस ग्रुप को डेटा मैसेज भेजने का तरीका बताया गया है.

डिवाइस ग्रुप के लिए एचटीटीपी पोस्ट अनुरोध

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to": "aUniqueKey",
  "data": {
    "hello": "This is a Firebase Cloud Messaging Device Group Message!",
   }
}

डिवाइस ग्रुप का एचटीटीपी रिस्पॉन्स

यहां "सफलता" का एक उदाहरण दिया गया है— notification_key से दो रजिस्ट्रेशन टोकन जुड़े हैं और दोनों को मैसेज भेजा गया था:

{
  "success": 2,
  "failure": 0
}

यहां "आंशिक सफलता" का एक उदाहरण दिया गया है — notification_key से जुड़े तीन रजिस्ट्रेशन टोकन हैं. मैसेज सिर्फ़ एक रजिस्ट्रेशन टोकन पर भेजा गया. इस रिस्पॉन्स मैसेज में ऐसे रजिस्ट्रेशन टोकन (registration_ids) की सूची दी गई है जिन्हें मैसेज नहीं मिला:

{
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

जब कोई मैसेज, notification_key से जुड़े एक या एक से ज़्यादा रजिस्ट्रेशन टोकन पर डिलीवर नहीं हो पाता है, तो ऐप्लिकेशन सर्वर को दो बार कोशिश करने के बाद, बैकऑफ़ के साथ फिर से कोशिश करनी चाहिए.

अगर सर्वर किसी ऐसे डिवाइस ग्रुप को मैसेज भेजने की कोशिश करता है जिसमें कोई सदस्य नहीं है, तो 0 सही और 0 असफल के साथ रिस्पॉन्स कुछ ऐसा दिखेगा:

{
  "success": 0,
  "failure": 0
}

डिवाइस ग्रुप XMPP मैसेज

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "to": "aUniqueKey",
      "message_id": "m-1366082849205" ,
      "data": {
          "hello":"This is a Firebase Cloud Messaging Device Group Message!"
      }
  }
  </gcm>
</message>

डिवाइस ग्रुप XMPP रिस्पॉन्स

जब ग्रुप के किसी एक डिवाइस पर मैसेज भेज दिया जाता है, तो XMPP कनेक्शन सर्वर, ACK के साथ जवाब देता है. अगर ग्रुप के सभी डिवाइसों पर भेजे गए सभी मैसेज फ़ेल हो जाते हैं, तो XMPP कनेक्शन सर्वर, NACK के साथ जवाब देता है.

यहां "सफलता" का एक उदाहरण दिया गया है — notification_key से तीन रजिस्ट्रेशन टोकन जुड़े हैं और मैसेज सभी को भेजा गया था:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success": 3,
  "failure": 0,
  "message_id": "m-1366082849205"
}

यहां "आंशिक सफलता" का एक उदाहरण दिया गया है — notification_key से जुड़े तीन रजिस्ट्रेशन टोकन हैं. मैसेज सिर्फ़ एक रजिस्ट्रेशन टोकन पर भेजा गया. रिस्पॉन्स मैसेज में, ऐसे रजिस्ट्रेशन टोकन शामिल किए जाते हैं जिन्हें मैसेज नहीं मिला:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

जब FCM कनेक्शन सर्वर, ग्रुप के सभी डिवाइसों पर डिलीवरी नहीं कर पाता है. ऐप्लिकेशन सर्वर को अच्छा जवाब मिलेगा.

मैसेज के विकल्पों की पूरी सूची देखने के लिए, अपने चुने गए कनेक्शन सर्वर प्रोटोकॉल, एचटीटीपी या XMPP की रेफ़रंस जानकारी देखें.

Firebase एडमिन SDK टूल के लेगसी मैसेज भेजने के तरीके

Firebase एडमिन Node.js SDK टूल, लेगसी FCM सर्वर एपीआई के आधार पर (FCM) मैसेज भेजने के तरीकों के साथ काम करता है. ये तरीके, send() तरीके की तुलना में अलग-अलग आर्ग्युमेंट स्वीकार करते हैं. जब भी हो सके, send() तरीके का इस्तेमाल करें. साथ ही, इस पेज में बताए गए तरीकों का इस्तेमाल सिर्फ़ अलग-अलग डिवाइसों या डिवाइस ग्रुप को मैसेज भेजते समय करें.

अलग-अलग डिवाइसों पर भेजें

उस डिवाइस पर मैसेज भेजने के लिए, sendToDevice() तरीके पर रजिस्ट्रेशन टोकन पास किया जा सकता है:

Node.js के लिए

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().sendToDevice(registrationToken, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDevice() वाला तरीका सिर्फ़ एक रजिस्ट्रेशन टोकन के बजाय, कई रजिस्ट्रेशन टोकन पास करके भी मल्टीकास्ट मैसेज भेज सकता है. इसका मतलब है कि एक से ज़्यादा डिवाइसों पर मैसेज भेजा जा सकता है:

Node.js के लिए

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...',
  // ...
  'ecupwIfBy1w:APA91bFtuMY7MktgxA3Au_Qx7cKqnf...'
];

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the devices corresponding to the provided
// registration tokens.
getMessaging().sendToDevice(registrationTokens, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDevice() तरीका, ऐसा प्रॉमिस देता है जिसे MessagingDevicesResponse ऑब्जेक्ट की मदद से रिज़ॉल्व किया जाता है. इस ऑब्जेक्ट में FCM से मिले रिस्पॉन्स को शामिल किया जाता है. सिंगल रजिस्ट्रेशन टोकन या रजिस्ट्रेशन टोकन के कलेक्शन को पास करते समय, रिटर्न टाइप का एक ही फ़ॉर्मैट होता है.

पुष्टि करने में गड़बड़ी या दर को सीमित करने जैसे कुछ मामलों की वजह से मैसेज पूरी तरह से प्रोसेस नहीं हो पाता. इन मामलों में, sendToDevice() से मिले प्रॉमिस को गड़बड़ी के साथ अस्वीकार कर दिया जाता है. गड़बड़ी के कोड की पूरी सूची देखने के लिए, एडमिन FCM एपीआई से जुड़ी गड़बड़ियां देखें. इस सूची में, गड़बड़ी का ब्यौरा और उसे ठीक करने के तरीके भी बताए गए हैं.

किसी डिवाइस ग्रुप को भेजें

sendToDeviceGroup() इस तरीके का इस्तेमाल करके, किसी डिवाइस ग्रुप के लिए सूचना कुंजी चुनकर उस डिवाइस ग्रुप को मैसेज भेजा जा सकता है:

Node.js के लिए

// See the "Managing device groups" link above on how to generate a
// notification key.
const notificationKey = 'some-notification-key';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device group corresponding to the provided
// notification key.
getMessaging().sendToDeviceGroup(notificationKey, payload)
  .then((response) => {
    // See the MessagingDeviceGroupResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDeviceGroup() तरीका, ऐसा प्रॉमिस देता है जिसे MessagingDevicesResponse ऑब्जेक्ट की मदद से रिज़ॉल्व किया जाता है. इस ऑब्जेक्ट में FCM से मिले रिस्पॉन्स को शामिल किया जाता है.

पुष्टि करने में गड़बड़ी या दर को सीमित करने जैसे कुछ मामलों की वजह से मैसेज पूरी तरह से प्रोसेस नहीं हो पाता. इन मामलों में, sendToDeviceGroup() से मिले प्रॉमिस को गड़बड़ी के साथ अस्वीकार कर दिया जाता है. गड़बड़ी के कोड की पूरी सूची देखने के लिए, एडमिन FCM एपीआई से जुड़ी गड़बड़ियां देखें. इस सूची में, गड़बड़ी का ब्यौरा और उसे ठीक करने के तरीके भी बताए गए हैं.

मैसेज पेलोड तय करना

FCM लेगसी प्रोटोकॉल पर आधारित ऊपर दिए गए तरीके मैसेज पेलोड को दूसरे तर्क के तौर पर स्वीकार करते हैं. साथ ही, वे सूचना और डेटा मैसेज, दोनों के लिए काम करते हैं. आप data और / या notification कुंजियों का इस्तेमाल करके कोई ऑब्जेक्ट बनाकर, एक या दोनों तरह के मैसेज तय कर सकते हैं. उदाहरण के लिए, यहां अलग-अलग तरह के मैसेज पेलोड तय करने का तरीका बताया गया है:

सूचना का मैसेज

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  }
};

डेटा मैसेज

const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

मिला-जुला मैसेज

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  data: {
    stock: 'GOOG',
    open: '829.62',
    close: '635.67'
  }
};

सूचना वाले मैसेज के पेलोड में मान्य प्रॉपर्टी का एक सबसेट होता है. हालांकि, यह इस आधार पर अलग-अलग होता है कि किस मोबाइल ऑपरेटिंग सिस्टम को टारगेट किया जा रहा है. पूरी सूची के लिए, NotificationMessagePayload के रेफ़रंस दस्तावेज़ देखें.

डेटा मैसेज पेलोड, पसंद के मुताबिक बनाए गए की-वैल्यू पेयर से बने होते हैं. इन पर कुछ पाबंदियां भी लागू होती हैं. इनमें यह शर्त भी शामिल होती है कि सभी वैल्यू, स्ट्रिंग ही होनी चाहिए. पाबंदियों की पूरी सूची के लिए, DataMessagePayload के रेफ़रंस दस्तावेज़ देखें.

मैसेज के विकल्प तय करना

FCM लेगसी प्रोटोकॉल पर आधारित ऊपर दिए गए तरीके, मैसेज के लिए कुछ विकल्पों को बताने वाला वैकल्पिक तीसरा तर्क स्वीकार करते हैं. उदाहरण के लिए, नीचे दिया गया उदाहरण ऐसे डिवाइस पर ज़्यादा प्राथमिकता वाला मैसेज भेजता है जिसकी समयसीमा 24 घंटे बाद खत्म हो जाती है:

Node.js के लिए

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section above for details
// on how to define a message payload.
const payload = {
  notification: {
    title: 'Urgent action needed!',
    body: 'Urgent action is needed to prevent your account from being disabled!'
  }
};

// Set the message as high priority and have it expire after 24 hours.
const options = {
  priority: 'high',
  timeToLive: 60 * 60 * 24
};

// Send a message to the device corresponding to the provided
// registration token with the provided options.
getMessaging().sendToDevice(registrationToken, payload, options)
  .then((response) => {
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

उपलब्ध विकल्पों की पूरी सूची के लिए, MessagingOptions के रेफ़रंस दस्तावेज़ देखें.