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

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

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

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

इस पेज पर दिए गए उदाहरण में बताया गया है कि Firebase एडमिन SDK (जिसमें Node, 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 के लिए, ऐसे लेगसी 'भेजें एपीआई' का इस्तेमाल किया जा रहा है जो अब काम नहीं करते, तो हमारा सुझाव है कि जल्द से जल्द HTTP v1 API पर माइग्रेट करें. इसके अलावा, Node.js के लिए Firebase एडमिन SDK टूल के किसी पुराने वर्शन का इस्तेमाल करके भी ऐसा किया जा सकता है. भेजे गए पुराने एपीआई को जून 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 डिवाइसों पर दिखाने के लिए एक खास आइकॉन और रंग सेट किया जाता है. जैसा कि AndroidNotifications के रेफ़रंस में बताया गया है, रंग #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"
          }
        ]
      }
    ]
  }
}

उदाहरण 2: अमान्य रजिस्ट्रेशन टोकन वाले एचटीटीपी 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 में भी किया जाता है, लेकिन पेलोड में उन्हें इस्तेमाल करने की अनुमति होती है. ऐसे में, पेलोड वैल्यू को 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 की सदस्यता नहीं ली है, तो उसे मैसेज नहीं मिलता है. इन कॉम्बिनेशन में यह सुविधा मिलती है:

  • विषयA और विषयB
  • 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 से जुड़े एक या उससे ज़्यादा रजिस्ट्रेशन टोकन में डिलीवर नहीं हो पाता है, तो ऐप्लिकेशन सर्वर को फिर से कोशिश करने के दौरान, बैकऑफ़ के लिए फिर से कोशिश करनी चाहिए.

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

{
  "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 से जुड़े रेफ़रंस दस्तावेज़ देखें.